Skip to main content
POST
The run is asynchronous. The response’s id is the file_collection_id, never a file_id. Poll for results with GET /v2/workflows/{workflow_id}/files/{id}/results/. That path segment reads files, but it takes the collection id. The endpoint returns 412 while processing and 200 once results are ready. See Packets and files.

Input Methods

Submit content in one of two ways:
  1. File upload. Send a binary file as multipart form data.
  2. Text input. Send plain text.
One request carries one input method. Send either file or text, never both.

Authorizations

Authorization
string
header
required

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

Headers

X-Anyformat-Priority
string | null

Path Parameters

workflow_id
string
required

Body

multipart/form-data
file
file | null

Response

Successful Response

Response after triggering a workflow run. Contains the collection ID to use for polling extraction results.

id
string
required

The collection UUID for this run. Use this ID to poll for results via GET /v2/workflows/{workflow_id}/files/{id}/results/.

Example:

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

status
enum<string>
required

Initial status of the run: queued (the run was accepted and enqueued, not that extraction is complete). Use GET /v2/workflows/{workflow_id}/files/{id}/results/ to poll the run through its in_progress / processed lifecycle.

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

"queued"

workflow_id
string
required

The UUID of the workflow that was executed.

Example:

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

version_id
string
required

The workflow version this run was bound to (the latest version at submission time). Lets callers verify which schema produced the results — useful right after an edit.

Example:

"FGaV4I2JAA"