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"
    }
  ]
}
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"
    }
  ]
}

Headers

​
authorization
string | null

Path Parameters

​
workflow_id
string
required

Response

Successful Response

Workflow detail — used for get, create, and list items.

​
id
string
required
​
name
string
required
​
description
string | null
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
fields
Fields · object[] | null