v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Extraction

Register File

Endpoint to Register a File for Extraction

This endpoint registers a file for extraction and returns a presigned URL for the file upload.


Request Body

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

Response Body

FieldTypeDescription
extraction_job_idstrThe ID of the extraction job.
file_namestrThe name of the registered file.
file_idstrThe ID of the registered file.
upload_urlstrThe presigned URL for file upload.

Errors

  • 400 Bad Request: If the file name is invalid or already registered for the job.
  • 500 Internal Server Error: If there is an unexpected error during the registration of the file.
post/document/extraction/register_file

Request body

extraction_job_idstring required
file_namestring required

Response

Successful Response

extraction_job_idstring required
file_namestring required
file_idstring required
upload_urlstring required