Sign in

v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
jobs

get/documents/v1/jobs/{job_id}

Path parameters

job_idstring required

The identifier of the job given at creation. Starts with job-

Response

Get Job Output

messagestring nullable

An error message if the job failed

This field is optional and will be None if the job was successful.

jobIdstring required

The unique identifier for the job

This is a public ID that can be used to reference the job in other API calls. It has the format of job-<readable-id>

fileIdstring nullable

The unique identifier for the file associated with the job

This is an optional field that will be None if the job was submitted with a public URL file.

fileNamestring nullable

The name of the file associated with the job

This is an optional field that will be None if the job was submitted with a public URL

traceIdstring nullable

The trace ID for the job

This value will be None if the job is in the Pending state.

This is used for tracing the job execution in the system.

Share this ID with the support team if you need help with a specific job.

pageRangestring nullable

The page range for the job

This value will be None if the job was submitted for the entire document. If the job was submitted with a specific page range, this will be in the format "1-5" or "1,3,5"

parsedPagesinteger nullable

The number of pages that were parsed in the job

This value will be None if the job is still processing or if it failed.

{"stackTrail":"components:schemas:JobResponse:properties:document","oasType":"schema","type":"unknown","description":"The document output of the job\n\nThis field is deprecated and will be removed in a future version. Use\n`outputs` instead."}
{"stackTrail":"components:schemas:JobResponse:properties:structuredOutput","oasType":"schema","type":"unknown","description":"The structured output of the job\n\nThis field is deprecated and will be removed in a future version. Use\n`outputs` instead."}
status'failure' | 'pending' | 'processing' | 'successful' required
tasksCompletedinteger nullable

The number of tasks that have been completed for the job

This field is optional and will be None if the job is still processing or if it failed.

tasksTotalinteger nullable

The total number of tasks that are expected to be completed for the job

This field is optional and will be None if the job is still processing or if it failed.

createdAtstring required

The timestamp when the job was created

finishedAtstring nullable

The timestamp when the job was finished, if applicable

labelsobject

Additional metadata for the job, that was provided during the parse request.