NAnace
Documents

Get Parse preview progress

Read current ready-unit metadata. This is a snapshot, not an incremental log.

Retained Parse jobs only. Authenticate with the same Bearer key as the job. Previews do not change parsing, cache identity, cost, retention or cancellation. Zero retention and some parsers return only the complete result. See Parse streaming.

get/v1/documents/jobs/{id}/parse-progress

Request

Path parameters

idstring uuid required

The Parse job_id.

Response

Current preview metadata or content.

job_idstring uuid required

Parse job being observed.

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

Backend lifecycle state; read the normal job for final result and billing.

generationstring nullable

Current parser invocation. A changed generation replaces the previous preview.

kind'page' | 'sheet' | 'section' | 'segment' | 'null' nullable

Natural unit being previewed.

totalinteger nullable

Number of requested units, when known.

moreboolean

Further units are omitted by the preview bound; the final result remains complete.

first_ready_atstring date-time nullable

Server publication time of the first nonempty preview; unknown is null.

all_ready_atstring date-time nullable

All selected units were saved. Document finalization can still be running.

Changes

No recorded changes to this operation across all 1 revision of this API.