Documents

Get a Parse preview unit

Read one bounded provisional Markdown unit. Use the content_url returned by a snapshot.

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/parts/{generation}/{revision}

Request

Path parameters

idstring uuid required

The Parse job_id.

generationstring required

Opaque value from the preview snapshot.

revisionstring required

Opaque value from the preview snapshot.

Response

Current preview metadata or content.

generationstring required

Parser invocation that produced the preview.

indexinteger required

Original page number or selected sheet position.

labelstring required

Page label or sheet name.

markdownstring required

Provisional Markdown, capped at 64K characters. Final tables and descriptions may differ.

truncatedboolean required

The preview exceeded its bound; fetch complete text from the final result.

ready_atstring date-time required

Server publication timestamp.

Changes

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