Get Document Packet

curl -X GET 'https://api.anyformat.ai/v3/document-packets/069dcc2c-e14c-7606-8000-2ee4fb17b4e1/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

document_packet_id = "069dcc2c-e14c-7606-8000-2ee4fb17b4e1"
url = f"https://api.anyformat.ai/v3/document-packets/{document_packet_id}/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

packet = requests.get(url, headers=headers).json()
print(packet["status"], packet["latest_run_id"])

{
  "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e1",
  "workflow_id": "0686bb97-8c30-70f0-8000-97669e000eb8",
  "name": "contract-bundle",
  "status": "processed",
  "created_at": "2026-07-01T12:00:00.000Z",
  "updated_at": "2026-07-01T12:05:00.000Z",
  "files": [
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e2", "name": "contract.pdf" },
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e3", "name": "annex-a.pdf" }
  ],
  "latest_run_id": "069dcc2c-e14c-7606-8000-2ee4fb17b4f9"
}

GET

document-packets

{document_packet_id}

curl -X GET 'https://api.anyformat.ai/v3/document-packets/069dcc2c-e14c-7606-8000-2ee4fb17b4e1/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

document_packet_id = "069dcc2c-e14c-7606-8000-2ee4fb17b4e1"
url = f"https://api.anyformat.ai/v3/document-packets/{document_packet_id}/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

packet = requests.get(url, headers=headers).json()
print(packet["status"], packet["latest_run_id"])

{
  "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e1",
  "workflow_id": "0686bb97-8c30-70f0-8000-97669e000eb8",
  "name": "contract-bundle",
  "status": "processed",
  "created_at": "2026-07-01T12:00:00.000Z",
  "updated_at": "2026-07-01T12:05:00.000Z",
  "files": [
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e2", "name": "contract.pdf" },
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e3", "name": "annex-a.pdf" }
  ],
  "latest_run_id": "069dcc2c-e14c-7606-8000-2ee4fb17b4f9"
}

Rate limit tier: general (600 req/min) — see Rate limits. Retrieves one document packet flat: extraction status, timestamps, the files it groups, and latest_run_id — the id of the packet’s most recent run, null until the packet has been run. latest_run_id is the hop to results: follow it with GET /v3/runs/{run_id}/. Run history is not embedded — list a workflow’s runs via GET /v3/workflows/{workflow_id}/runs/. Unknown ids — including packets belonging to another organization — return 404.

curl -X GET 'https://api.anyformat.ai/v3/document-packets/069dcc2c-e14c-7606-8000-2ee4fb17b4e1/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

document_packet_id = "069dcc2c-e14c-7606-8000-2ee4fb17b4e1"
url = f"https://api.anyformat.ai/v3/document-packets/{document_packet_id}/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

packet = requests.get(url, headers=headers).json()
print(packet["status"], packet["latest_run_id"])

{
  "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e1",
  "workflow_id": "0686bb97-8c30-70f0-8000-97669e000eb8",
  "name": "contract-bundle",
  "status": "processed",
  "created_at": "2026-07-01T12:00:00.000Z",
  "updated_at": "2026-07-01T12:05:00.000Z",
  "files": [
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e2", "name": "contract.pdf" },
    { "id": "069dcc2c-e14c-7606-8000-2ee4fb17b4e3", "name": "annex-a.pdf" }
  ],
  "latest_run_id": "069dcc2c-e14c-7606-8000-2ee4fb17b4f9"
}

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.

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.

Show child attributes

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. null when no metadata was attached.

List Document Packets Run Document Packet