Skip to content

Create Document Job Endpoint

POST
/v1/documents
curl --request POST \
--url http://localhost:8080/v1/documents \
--header 'Content-Type: multipart/form-data' \
--form file=example \
--form template_id=example \
--form template_name=example \
--form processing_mode=example \
--form page_range=example
Media type multipart/form-data
Body_create_document_job_endpoint_v1_documents_post
object
file
required
File
string
template_id
Any of:
string
template_name
Any of:
string
processing_mode
Any of:
string
page_range
Any of:
string

Successful Response

Media type application/json
JobSubmissionResponse
object
job_id
required
Job Id
string
deduplicated
required
Deduplicated
boolean
status
required
Status
string
Allowed value: queued
Example
{
"status": "queued"
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}