> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anyformat.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List Workflows
> List workflows with pagination and optional filtering
The maximum `page_size` is 100. Requests exceeding this value are silently capped at 100.
```bash curl theme={null}
curl -X GET 'https://api.anyformat.ai/v2/workflows/?page=1&page_size=20' \
-H 'Authorization: Bearer YOUR_API_KEY'
```
```python Python (requests) theme={null}
import requests
url = "https://api.anyformat.ai/v2/workflows/"
headers = {
"Authorization": "Bearer YOUR_API_KEY"
}
params = {"page": 1, "page_size": 20}
response = requests.get(url, headers=headers, params=params)
print(response.json())
```
```javascript JavaScript theme={null}
const response = await fetch('https://api.anyformat.ai/v2/workflows/?page=1&page_size=20', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
});
const data = await response.json();
console.log(data);
```
```typescript TypeScript theme={null}
interface Workflow {
id: string;
name: string;
description: string | null;
created_at: string;
updated_at: string;
}
interface WorkflowListResponse {
count: number;
page: number;
page_size: number;
results: Workflow[];
}
const response = await fetch('https://api.anyformat.ai/v2/workflows/?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: WorkflowListResponse = await response.json();
console.log(data.results);
```
```json Response (200 OK) theme={null}
{
"count": 2,
"page": 1,
"page_size": 20,
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Invoice Processing",
"description": "Extract data from invoice documents",
"created_at": "2024-03-24T12:00:00.000Z",
"updated_at": "2024-03-24T12:00:00.000Z"
},
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Receipt Processing",
"description": null,
"created_at": "2024-03-24T13:00:00.000Z",
"updated_at": "2024-03-24T13:00:00.000Z"
}
]
}
```
## OpenAPI
````yaml GET /v2/workflows/
openapi: 3.1.0
info:
title: anyformat API
description: >
Document extraction and workflow automation API.
AnyFormat lets you define extraction workflows that pull structured data
from any document — PDFs, images, scanned files, or plain text. Upload a
file, run it through a workflow, and get back structured fields with
confidence scores and source evidence.
## Quick start
See the [Quick start
guide](https://docs.anyformat.ai/api-reference/introduction) for a
walkthrough.
## Authentication
All endpoints (except `/health/`) require a Bearer token in the
`Authorization` header:
```
Authorization: Bearer
```
Get your API key from
[app.anyformat.ai/api-key](https://app.anyformat.ai/api-key).
## Versioning
Endpoints are versioned by path prefix (`/v2/`, `/v3/`). Every response
under
a versioned prefix includes `X-API-Version`.
version: 2.0.0
servers:
- url: https://api.anyformat.ai
description: API server
security: []
tags:
- name: workflows
description: >-
Workflows define extraction templates — what fields to extract from
documents. Create workflows, upload files, run extractions, and fetch
results.
- name: files
description: >-
File collections group uploaded documents and track their extraction
progress. Upload files, check status, and retrieve extraction results.
- name: suggestions
description: >-
AI-powered schema and workflow suggestion endpoints for the AnyFormat
webapp. Authenticated with a Cognito JWT rather than an API key.
- name: document-packets
description: >-
Document packets group uploaded documents for a workflow (v3). Address a
packet directly to (re-)run its workflow.
- name: runs
description: >-
Extraction runs — the v3 first-class result entity. Each run is a single
execution of a workflow against a document packet; fetch its status and
results flat by run id.
- name: health
description: Health check endpoints to verify API availability.
paths:
/v2/workflows/:
get:
tags:
- workflows
summary: List workflows
description: |-
List all workflows in your organization with pagination.
Workflows can be filtered by status and sorted by any field.
operationId: v2_list_workflows
parameters:
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 20
title: Page Size
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
title: Page
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Status
- name: sort_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort By
- name: order
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Order
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowListResponse'
headers:
X-RateLimit-Limit:
description: Requests allowed per window (60s).
schema:
type: integer
X-RateLimit-Remaining:
description: Requests remaining in the current window.
schema:
type: integer
X-RateLimit-Reset:
description: Seconds until the current window resets.
schema:
type: integer
'401':
description: Authentication failed — missing, invalid, or expired API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
examples:
AUTH_FAILED:
value:
error: Authentication failed.
detail: Authentication failed.
error_code: AUTH_FAILED
retryable: false
request_id: req_abc123
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'429':
description: >-
Rate limited — retry after the `Retry-After` header. Default
windows: 60 requests/minute for extraction submission, 600
requests/minute for general endpoints.
headers:
Retry-After:
description: Seconds until the next request is allowed.
schema:
type: integer
X-RateLimit-Limit:
description: Requests allowed per window (60s).
schema:
type: integer
X-RateLimit-Remaining:
description: Requests remaining in the current window.
schema:
type: integer
X-RateLimit-Reset:
description: Seconds until the current window resets.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
examples:
RATE_LIMITED:
value:
error: Rate limit exceeded — retry after backoff.
detail: Rate limit exceeded — retry after backoff.
error_code: RATE_LIMITED
retryable: true
request_id: req_abc123
security:
- ApiKeyAuth: []
components:
schemas:
WorkflowListResponse:
properties:
results:
items:
$ref: '#/components/schemas/WorkflowResponse'
type: array
title: Results
description: List of workflows for the current page.
count:
type: integer
title: Count
description: Total number of workflows matching the query.
examples:
- 4
page:
type: integer
title: Page
description: Current page number.
examples:
- 1
page_size:
type: integer
title: Page Size
description: Number of results per page.
examples:
- 20
type: object
required:
- results
- count
- page
- page_size
title: WorkflowListResponse
description: Paginated list of workflows.
ErrorEnvelope:
type: object
title: ErrorEnvelope
description: >-
Uniform error response. `retryable=true` means the same request may
succeed on retry (with backoff); `retryable=false` means the caller must
change the request before retrying.
required:
- error
- detail
- error_code
- retryable
- request_id
properties:
error:
type: string
description: Short human-readable summary.
detail:
description: >-
Machine-readable detail. String for most errors; list of field
errors for validation failures.
oneOf:
- type: string
- type: array
items:
type: object
error_code:
type: string
description: Stable identifier for programmatic handling.
examples:
- VALIDATION_ERROR
- AUTH_FAILED
- NOT_FOUND
- PRECONDITION_FAILED
- RATE_LIMITED
- INTERNAL_ERROR
- GATEWAY_TIMEOUT
retryable:
type: boolean
description: True when the caller should retry (with backoff for 429/412/5xx).
request_id:
type: string
description: Correlates this response with server logs.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WorkflowResponse:
properties:
id:
type: string
title: Id
description: Unique identifier of the workflow (UUID).
examples:
- 0686bb97-8c30-70f0-8000-97669e000eb8
name:
type: string
title: Name
description: Human-readable name of the workflow.
examples:
- Invoice Processing
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Optional description of what this workflow extracts.
examples:
- A workflow for processing invoices and retrieving invoice details.
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Timestamp when the workflow was created (ISO 8601).
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Timestamp when the workflow was last modified (ISO 8601).
fields:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Fields
description: >-
List of extraction field definitions configured for this workflow.
`null` if not yet configured.
type: object
required:
- id
- name
title: WorkflowResponse
description: >-
A workflow defines the extraction template — what fields to extract from
documents, their types, and validation rules.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
ApiKeyAuth:
type: http
description: >-
API key issued from app.anyformat.ai/api-key. Send as `Authorization:
Bearer `.
scheme: bearer
````