operations

get_parse_progress

Read bounded ready-unit metadata. Preview content is fetched individually.

get/v1/jobs/{job_id}/parse-progress

Request

Base URL
https://ndi-api.nace.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/nace/apis/ndi-service/docs/v1/jobs/:job_id/parse-progress/get.ts
A function with typed inputs. Its response is checked against the schema.

job_idstring uuid required

Successful Response

job_idstring uuid required

Parse job being observed.

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

cancelled is a first-class terminal status, not a failed variant.

Conflating them makes error-rate metrics lie and forces every client to string-match an error code.

generationstring nullable

Provider invocation whose preview is current.

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

Natural unit of this preview.

totalinteger nullable

Number of requested units when known.

moreboolean

The bounded preview omits further units; the final result remains complete.

first_ready_atstring date-time nullable

Server publication time of the first nonempty preview; null when not measured or unavailable.

all_ready_atstring date-time nullable

Server publication time when every requested preview was saved; document finalization can follow.

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