v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Extraction

Get File Status

Endpoint to Get the Status of a File from an Extraction Job

This endpoint returns the status of a file from an extraction job.


Request Body

FieldTypeDescription
extraction_job_idstrThe ID of the extraction job.
file_namestrThe name of the file.

Response Body

FieldTypeDescription
extraction_job_idstrThe ID of the extraction job.
statusstrThe status of the file. Can be COMPLETED or QUEUED.
result_urlstrThe presigned URL for the extracted text file.

Errors

  • 404: If the file is not found.
  • 500: If any other error occurs during the retrieval of the file status.
post/document/extraction/file_status

Request body

extraction_job_idstring required
file_namestring required

Response

Successful Response

statusstring required
result_urlstring
extraction_job_idstring required