Run Uploaded File - anyformat

curl -X POST 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

workflow_id = "550e8400-e29b-41d4-a716-446655440000"
file_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  # file_id from upload
url = f"https://api.anyformat.ai/v2/workflows/{workflow_id}/files/{file_id}/run/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.post(url, headers=headers)
print(response.json())

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const fileId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; // file_id from upload

const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/files/${fileId}/run/`,
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
  }
);

const data = await response.json();
console.log(data.id);

{
  "id": "c0ffee00-0000-4000-8000-000000000000",
  "status": "pending",
  "workflow_id": "550e8400-e29b-41d4-a716-446655440000",
  "version_id": "FGaV4I2JAA"
}

POST

workflows

{workflow_id}

files

{file_id}

run

curl -X POST 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

workflow_id = "550e8400-e29b-41d4-a716-446655440000"
file_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  # file_id from upload
url = f"https://api.anyformat.ai/v2/workflows/{workflow_id}/files/{file_id}/run/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.post(url, headers=headers)
print(response.json())

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const fileId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; // file_id from upload

const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/files/${fileId}/run/`,
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
  }
);

const data = await response.json();
console.log(data.id);

{
  "id": "c0ffee00-0000-4000-8000-000000000000",
  "status": "pending",
  "workflow_id": "550e8400-e29b-41d4-a716-446655440000",
  "version_id": "FGaV4I2JAA"
}

The companion to Upload File. Once a file is staged, call this to process it — pass the file_id you got back from the upload response as the file_id path parameter. The run is asynchronous — poll GET /v2/workflows/{workflow_id}/files/{collection_id}/results/ (using the collection id from the response below) for the output.

file_id is the file_id from the upload response — the individual file handle, not the file_collection_id. See Packets and files. For upload-and-process in one call, use Run Workflow instead.

curl -X POST 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

workflow_id = "550e8400-e29b-41d4-a716-446655440000"
file_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  # file_id from upload
url = f"https://api.anyformat.ai/v2/workflows/{workflow_id}/files/{file_id}/run/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.post(url, headers=headers)
print(response.json())

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const fileId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'; // file_id from upload

const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/files/${fileId}/run/`,
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
  }
);

const data = await response.json();
console.log(data.id);

{
  "id": "c0ffee00-0000-4000-8000-000000000000",
  "status": "pending",
  "workflow_id": "550e8400-e29b-41d4-a716-446655440000",
  "version_id": "FGaV4I2JAA"
}

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

file_id

string

required

Response

Successful Response

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

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"

Upload File List Workflow Runs