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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Invoice Extraction",
  "description": "Extract data from invoice documents",
  "created_at": "2024-03-24T12:00:00Z",
  "updated_at": "2024-03-24T12:00:00Z",
  "fields": [
    {
      "name": "invoice_number",
      "description": "The unique invoice identifier",
      "type": "string"
    },
    {
      "name": "total_amount",
      "description": "Total invoice amount including tax",
      "type": "float"
    }
  ]
}

curl -X GET 'https://api.anyformat.ai/workflows/550e8400-e29b-41d4-a716-446655440000/' \
  -H 'x-api-key: YOUR_API_KEY'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Invoice Extraction",
  "description": "Extract data from invoice documents",
  "created_at": "2024-03-24T12:00:00Z",
  "updated_at": "2024-03-24T12:00:00Z",
  "fields": [
    {
      "name": "invoice_number",
      "description": "The unique invoice identifier",
      "type": "string"
    },
    {
      "name": "total_amount",
      "description": "Total invoice amount including tax",
      "type": "float"
    }
  ]
}

​
Query Parameters

ParameterTypeDescription
includestringComma-separated list of related data to include (e.g., results,stats)

Authorizations

​
X-API-Key
string
header
required

API key authentication. Add your API key with the X-API-Key header.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Comma-separated list of related data to include (e.g., 'results,stats')

Response

200 - application/json
​
id
string
required
​
name
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
results
object[] | null
​
fields
object[] | null