Get a packet

Required scope: documents:download.

Returns a packet's generation state (queued, running, ready or failed) and its freshness (fresh, stale or unknown), which tells you whether the source documents have changed since generation. source_checked_at is when that check ran, or null if it could not run.

A packet is ready only after the merged file has been verified. When generation fails, failure gives the reason. Reading a packet never regenerates it.

GET /api/v2/packets/{id}
Bearer token scope documents:download

Path parameters

· 1
id string required

Packet ID.

Responses