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.

Digitise 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

formatstringOptional

Output format of the results, e.g. json.

Response

OK
extractobject

Job results for the extract pipeline.

OR
digitiseobject

Job results for the digitise pipeline.

Errors

404
Not Found Error
409
Conflict Error