v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Extraction

Get Job Status

Endpoint to Get the Status of an Extraction Job

This endpoint returns the status of an extraction job.


Request Parameters

ParameterTypeDescription
extraction_job_idstrThe ID of the extraction job.

Response Body

FieldTypeDescription
job_idstrThe ID of the extraction job.
completed_file_countintThe number of files completed.
total_file_countintThe total number of files.
failed_file_countintThe number of files failed.
statusstrThe status of the extraction job. Can be CREATED, STARTED, IN_PROGRESS, COMPLETED, or COMPLETED_WITH_ERRORS.

Errors

  • 404: If the job ID is not found.
  • 500: If any other error occurs during the retrieval of the job status.
get/document/extraction/job_status/{extraction_job_id}

Path parameters

extraction_job_idstring required

Response

Successful Response

job_idstring required
completed_file_countinteger required
total_file_countinteger required
failed_file_countinteger required
statusstring required