v1
Document

Get Document Status

Get processing status for an uploaded document.

Pass ?timeline=true to include step-by-step processing detail without changing the default flat status fields.

get/v1/document/status/{upload_id}

Path parameters

upload_idstring required

Query parameters

timelineboolean

When true, include a timeline object with ordered processing steps, per-step status, and timing. Default response shape is unchanged.

When true, include a timeline object with ordered processing steps, per-step status, and timing. Default response shape is unchanged.

Response

Document processing status. Include ?timeline=true for step detail.

upload_idstring required

Document upload identifier

statusstring required

Current processing status

progressnumber nullable

Overall progress from 0.0 to 1.0

current_pageinteger nullable

Current page being processed

total_pagesinteger nullable

Total pages in the document

errorstring nullable

Customer-safe error message when processing failed

timestampstring date-time nullable

Timestamp of the latest status update

page_idstring nullable

User-facing document Post ID, when available

workflow_typestring nullable

Processing backend type

messagestring nullable

Additional status message

Changes

Changed in 5 of the 37 revisions of this API.21027

    • added the new optional query request parameter timeline

      new-optional-request-parameter

    • added the optional property current_page to the response with the 200 status

      response-optional-property-added

    • added the optional property error to the response with the 200 status

      response-optional-property-added

    • added the optional property message to the response with the 200 status

      response-optional-property-added

    • added the optional property page_id to the response with the 200 status

      response-optional-property-added

    • added the optional property progress to the response with the 200 status

      response-optional-property-added

    • added the optional property timeline to the response with the 200 status

      response-optional-property-added

    • added the optional property timestamp to the response with the 200 status

      response-optional-property-added

    • added the optional property total_pages to the response with the 200 status

      response-optional-property-added

    • added the optional property workflow_type to the response with the 200 status

      response-optional-property-added

    • added the required property status to the response with the 200 status

      response-required-property-added

    • added the required property upload_id to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 22d84aa060d6210See the full diff
    • removed the required property status from the response with the 200 status

      response-required-property-removed

    • removed the required property upload_id from the response with the 200 status

      response-required-property-removed

    • deleted the query request parameter timeline

      request-parameter-removed

    • removed the optional property current_page from the response with the 200 status

      response-optional-property-removed

    • removed the optional property error from the response with the 200 status

      response-optional-property-removed

    • removed the optional property message from the response with the 200 status

      response-optional-property-removed

    • removed the optional property page_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property progress from the response with the 200 status

      response-optional-property-removed

    • removed the optional property timeline from the response with the 200 status

      response-optional-property-removed

    • removed the optional property timestamp from the response with the 200 status

      response-optional-property-removed

    • removed the optional property total_pages from the response with the 200 status

      response-optional-property-removed

    • removed the optional property workflow_type from the response with the 200 status

      response-optional-property-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter timeline

      new-optional-request-parameter

    • added the optional property current_page to the response with the 200 status

      response-optional-property-added

    • added the optional property error to the response with the 200 status

      response-optional-property-added

    • added the optional property message to the response with the 200 status

      response-optional-property-added

    • added the optional property page_id to the response with the 200 status

      response-optional-property-added

    • added the optional property progress to the response with the 200 status

      response-optional-property-added

    • added the optional property timeline to the response with the 200 status

      response-optional-property-added

    • added the optional property timestamp to the response with the 200 status

      response-optional-property-added

    • added the optional property total_pages to the response with the 200 status

      response-optional-property-added

    • added the optional property workflow_type to the response with the 200 status

      response-optional-property-added

    • added the required property status to the response with the 200 status

      response-required-property-added

    • added the required property upload_id to the response with the 200 status

      response-required-property-added

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    • endpoint added

      endpoint-added

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog