GET/extract/{jobId}

Get extract job status and results

Retrieves the status and results of an extract job. Use jobId to identify the job and check whether it is queued, active, completed, or failed. Completed results include extracted data and may include a generated JSON Schema when the request did not provide one.

1 parameter
jobIdstringrequired
The identifier of the extract job to retrieve.

4 status codes
200Returns the job status and may include error information, extracted data, and a generated JSON Schema when no schema was provided in the request.
statusstringrequired
Current status of the job
Allowed:queuedactivecompletedfailed
errorobjectoptional
Error information if the job failed
dataobjectoptional
Extracted data from the video, structured according to the schema
schemaobjectoptional
JSON Schema generated by AI. Only present when no schema was provided in the request.
400Returned when the request is invalid.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the extract job is not found.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 indicates an invalid request, a 404 a missing resource, and a 500 an internal error. The jobId path parameter must identify the extract job whose status and results you need.