Skip to main content
GET
Rate limit tier: general, 600 requests/min. See Rate limits. Returns one document packet flat: extraction status, timestamps, the files it groups, latest_run_id, and any metadata supplied at creation. latest_run_id names the packet’s most recent run, and is null until the packet has run. It is the hop to results: follow it with GET /v3/runs/{run_id}/. The response embeds no run history. List a workflow’s runs with GET /v3/workflows/{workflow_id}/runs/. metadata is the free-form JSON object the caller attached on create, and is null when the caller attached none. See Attaching metadata for how it flows through extraction. An unknown id returns 404, as does a packet belonging to another organization.

Authorizations

Authorization
string
header
required

API key issued from app.anyformat.ai/api-key. Send as Authorization: Bearer <key>.

Path Parameters

document_packet_id
string
required

Response

Successful Response

A packet with its per-file breakdown and latest run reference.

id
string
required

Unique identifier of the document packet (hyphenated UUID).

Example:

"069dcc2c-e14c-7606-8000-2ee4fb17b4e1"

workflow_id
string
required

The workflow this packet belongs to (hyphenated UUID).

Example:

"0686bb97-8c30-70f0-8000-97669e000eb8"

status
enum<string>
required

Processing status. Non-terminal: not_started, queued, in_progress. Terminal: processed (success), error, cancelled.

Available options:
not_started,
queued,
in_progress,
processed,
error,
cancelled
Example:

"processed"

files
DocumentPacketFileV3 · object[]
required

Files in this packet.

name
string | null

Human-readable name of the packet.

created_at
string<date-time> | null

Timestamp when the packet was created (ISO 8601).

updated_at
string<date-time> | null

Timestamp when the packet was last updated (ISO 8601).

latest_run_id
string | null

Id of the packet's most recent run (hyphenated UUID); null until the packet has been run.

metadata
Metadata · object | null

Free-form JSON supplied at packet creation. No schema is enforced; the extract operator may source datapoints from a top-level key whose name matches a schema field, and from free text under __anyformat_free_text__. null when no metadata was attached.