Skip to main content
GET
/
v2
/
workflows
/
{workflow_id}
/
runs
/
curl -X GET 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/runs/?page=1&page_size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

workflow_id = "550e8400-e29b-41d4-a716-446655440000"
url = f"https://api.anyformat.ai/v2/workflows/{workflow_id}/runs/"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}
params = {"page": 1, "page_size": 20}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/runs/?page=1&page_size=20`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

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

interface WorkflowRun {
  id: string;
  status: string;
  created_at: string | null;
  updated_at: string | null;
}

interface WorkflowRunListResponse {
  results: WorkflowRun[];
  count: number;
  page: number;
  page_size: number;
}

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/runs/?page=1&page_size=20`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

if (!response.ok) {
  throw new Error(`API error: ${response.status}`);
}

const data: WorkflowRunListResponse = await response.json();
console.log(data.results);

{
  "count": 42,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "processed",
      "created_at": "2024-03-24T12:00:00.000Z",
      "updated_at": "2024-03-24T12:02:30.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "in_progress",
      "created_at": "2024-03-24T13:00:00.000Z",
      "updated_at": "2024-03-24T13:00:15.000Z"
    }
  ]
}
Each run corresponds to one file collection, identified by UUID.

​
Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number (minimum: 1)
page_sizeinteger20Items per page (minimum: 1, maximum: 100)
curl -X GET 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/runs/?page=1&page_size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

workflow_id = "550e8400-e29b-41d4-a716-446655440000"
url = f"https://api.anyformat.ai/v2/workflows/{workflow_id}/runs/"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}
params = {"page": 1, "page_size": 20}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/runs/?page=1&page_size=20`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

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

interface WorkflowRun {
  id: string;
  status: string;
  created_at: string | null;
  updated_at: string | null;
}

interface WorkflowRunListResponse {
  results: WorkflowRun[];
  count: number;
  page: number;
  page_size: number;
}

const workflowId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
  `https://api.anyformat.ai/v2/workflows/${workflowId}/runs/?page=1&page_size=20`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

if (!response.ok) {
  throw new Error(`API error: ${response.status}`);
}

const data: WorkflowRunListResponse = await response.json();
console.log(data.results);

{
  "count": 42,
  "page": 1,
  "page_size": 20,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "processed",
      "created_at": "2024-03-24T12:00:00.000Z",
      "updated_at": "2024-03-24T12:02:30.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "in_progress",
      "created_at": "2024-03-24T13:00:00.000Z",
      "updated_at": "2024-03-24T13:00:15.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workflow_id
string
required

Query Parameters

​
page
integer
default:1
deprecated

Deprecated. Use cursor for stable keyset pagination — offset pagination can skip or repeat rows when the underlying list changes between requests.

Required range: x >= 1
​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
cursor
string | null

Opaque token from a previous response's next_cursor. When present, page is ignored and pagination uses keyset order.

Response

Successful Response

Paginated list of workflow runs.

​
results
WorkflowRunListItem · object[]
required

List of runs for the current page.

​
count
integer
required

Total number of runs for this workflow.

Example:

3

​
page
integer
required
deprecated

Deprecated. Current page number when using offset pagination. Prefer next_cursor.

Example:

1

​
page_size
integer
required

Number of results per page.

Example:

20

​
next_cursor
string | null

Opaque token to fetch the next page in keyset order. Present when the caller sent a cursor query param and more rows may follow; null on the last page.