Skip to main content
POST
Rate limit tier: submission, 60 requests/min. See Rate limits. Runs, or re-runs, a document packet on the latest version of its workflow. The path is flat: the packet already knows its workflow, so no workflow_id appears in the URL. Every call creates a new run. Re-running the same document after editing the workflow is the intended flow. Earlier runs stay readable at GET /v3/runs/{run_id}/ with their own results. The platform meters a re-run like a fresh run. See How credits work. An Idempotency-Key replay is the one exception. Retrying with the same key returns the original run, and triggers and bills no second extraction. See Idempotency. An unknown id returns 404, as does a packet belonging to another organization. An organization without extraction credit receives 402 PAYMENT_REQUIRED.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string | null

Optional caller-supplied key (Stripe convention). Retrying the request with the same key returns the original run instead of triggering (and billing) a second extraction.

X-Anyformat-Priority
string | null

Path Parameters

document_packet_id
string
required

Response

Successful Response

202 response for both run triggers (upload/run/ and document-packets/{id}/run/).

run_id
string
required

Unique identifier of the new run (hyphenated UUID).

Example:

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

document_packet_id
string
required

The document packet the run executes on (hyphenated UUID).

Example:

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

workflow_id
string
required

The workflow being run (hyphenated UUID).

Example:

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

status
enum<string>
required

Status at acceptance time — normally queued.

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

"queued"