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

{
  "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",
  "fields": [
    {
      "name": "invoice_number",
      "description": "The unique invoice identifier",
      "data_type": "string"
    },
    {
      "name": "total_amount",
      "description": "Total invoice amount including tax",
      "data_type": "float"
    }
  ]
}

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.

Retrieve a single workflow by ID, including its field definitions.
Workflows cannot be modified via the API. To update a workflow’s fields or configuration, use the anyformat platform where you can create new workflow versions while preserving the original. Alternatively, create a new workflow via the API and delete the old one.
curl -X GET 'https://api.anyformat.ai/v2/workflows/550e8400-e29b-41d4-a716-446655440000/' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "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",
  "fields": [
    {
      "name": "invoice_number",
      "description": "The unique invoice identifier",
      "data_type": "string"
    },
    {
      "name": "total_amount",
      "description": "Total invoice amount including tax",
      "data_type": "float"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workflow_id
string
required

Response

Successful Response

A workflow defines the extraction template — what fields to extract from documents, their types, and validation rules.

​
id
string
required

Unique identifier of the workflow (UUID).

Example:

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

​
name
string
required

Human-readable name of the workflow.

Example:

"Invoice Processing"

​
description
string | null

Optional description of what this workflow extracts.

Example:

"A workflow for processing invoices and retrieving invoice details."

​
created_at
string<date-time> | null

Timestamp when the workflow was created (ISO 8601).

​
updated_at
string<date-time> | null

Timestamp when the workflow was last modified (ISO 8601).

​
fields
Fields · object[] | null

List of extraction field definitions configured for this workflow. null if not yet configured.