Documents

Create a document reprocessing job

Changed on

Creates a new job to reprocess an existing document without changing its file content. The job runs the processing settings saved on the document's collection, so changing those settings and reprocessing brings the document in line with what an upload to that collection would now produce, including dropping components those settings no longer call for. A document belonging to no collection, or to collections whose settings differ, is reprocessed with the full pipeline. Returns 400 for a 'pages' request against a collection whose settings have no single-page form (one reading the embedded text layer, which is read for every page at once, or one running no page stages); reprocess the whole document instead.

post/api/v0/documents/{document_id}/reprocessing-jobs

Request

Path parameters

document_idstring uuid required

Request body

batch_modeboolean nullable

Run the deferrable pipeline stages through the provider's batch API at reduced cost; deferred artifacts fill in asynchronously after the job completes. Omit to use the deployment default. Applies to whole-document reprocessing only; a per-page reprocess always runs live.

Response

Successful Response

job_status_idstring uuid required

The ID of the job status.

statusstring required

The status of the job. Options: pending, done, error.

error_messagestring nullable required

The error message if the job failed.

document_idstring uuid nullable required

The ID of the document that was uploaded.

Changes

    • warning

      removed the request property /

    • info

      added the new optional request property /