v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Extraction

Start Extraction Job

Endpoint to Start an Extraction Job

This endpoint starts an extraction job by adding all registered files to the SQS queue for processing.


Request Body

FieldTypeDescription
extraction_job_idstrThe ID of the extraction job.

Response Body

FieldTypeDescription
extraction_job_idstrThe ID of the extraction job.
total_filesintThe total number of files registered for the job.
statusstrThe status of the extraction job. Returns STARTED if the job is started successfully.

Errors

  • 400: If the job is already started or completed.
  • 404: If the job ID is not found.
  • 500: If any other error occurs during the start process.
post/document/extraction/start_job

Request body

extraction_job_idstring required

Response

Successful Response

extraction_job_idstring required
total_filesinteger required
status'CREATED' | 'STARTED' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'FAILED'