Documents

Stream Parse preview progress

Streams snapshot events for up to 55 seconds, with heartbeat comments. Reconnect after closure for current state; replace units by generation/index/revision instead of appending duplicates. An unavailable event means previews stopped, not that the job failed. Always read the normal job for final result and billing.

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/events

Request

Path parameters

idstring uuid required

The Parse job_id.

Response

Current preview metadata or content.

Changes

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