Skip to main content
POST
/
v1
/
workflows
from retab import Retab

client = Retab()

workflow = client.workflows.create(
    name="Invoice Processing",
    description="Extract invoice fields and route for review",
)

print(workflow.id)
print(workflow.published)  # None — newly created workflows are unpublished
{
  "id": "wf_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "organization_id": "org_123",
  "published": null,
  "email_trigger": {
    "allowed_senders": [],
    "allowed_domains": []
  },
  "created_at": "2026-05-01T14:30:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a new workflow. The workflow is created unpublished, with a default start block at canvas position (0, 0). Use the Blocks and Edges endpoints to build out the graph, then Publish when you’re ready to run it.
from retab import Retab

client = Retab()

workflow = client.workflows.create(
    name="Invoice Processing",
    description="Extract invoice fields and route for review",
)

print(workflow.id)
print(workflow.published)  # None — newly created workflows are unpublished
{
  "id": "wf_abc123xyz",
  "name": "Invoice Processing",
  "description": "Extract invoice fields and route for review",
  "organization_id": "org_123",
  "published": null,
  "email_trigger": {
    "allowed_senders": [],
    "allowed_domains": []
  },
  "created_at": "2026-05-01T14:30:00Z",
  "updated_at": "2026-05-01T14:30:00Z"
}

Authorizations

Api-Key
string
header
required

Query Parameters

access_token
string | null

Body

application/json
name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

Response

Successful Response

Public workflow resource returned by workflow metadata endpoints.

id
string
required

Unique ID for this workflow

name
string
default:Untitled Workflow

The name of the workflow

description
string
default:""

Description of the workflow

organization_id
string | null

The organization that owns this workflow

published
WorkflowPublished · object

Published workflow metadata when a published snapshot exists

email_trigger
WorkflowEmailTrigger · object

Email trigger allowlist policy

email_senders_whitelist
string[]

Legacy mirror of allowed sender email addresses.

email_domains_whitelist
string[]

Legacy mirror of allowed sender email domains.

created_at
string<date-time>
updated_at
string<date-time>