Skip to navigation

Get Job Results

View as Markdown

Returns terminal job results. Results are never available while a job is running; requesting them before a terminal status returns 409.

Parse results include job_id, type, status, usage and documents.

Extract results include job_id, type, status, usage, result, annotations and version. annotations mirrors the result shape; every leaf has confidence and sources.

Authentication

api-subscription-keystring
API Key authentication via header

Path parameters

job_idstringRequired
The unique identifier of the job.

Query parameters

formatenumOptionalDefaults to json

Output format of the results. Choose md for Markdown, html for HTML, or json for structured JSON. If you omit format, the results are returned as json by default.

Allowed values:
includeenumOptional

Set to details for Classify and Split jobs to add inspected pages, provenance and boundary details. Supporting evidence also needs output.include_evidence on the request.

Allowed values:

Response

OK
extractobject

Job results for the extract pipeline.

OR
parseobject

Job results for the parse pipeline.

OR
classifyobject

Job results for the classify pipeline.

OR
splitobject

Job results for the split pipeline.

Errors

404
Not Found Error
409
Conflict Error