Skip to main content
POST
Create workflow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The Workflow to create

The Workflow to create

name
string
required

The human-readable name of the workflow.

Example:

"My Workflow"

status
number
required

The status of the workflow (0 = draft, 1 = active, 2 = paused).

Example:

1

flow
object

The workflow configuration storing nodes and edges.

Example:

Response

The Workflow

Defines an automation workflow with its configuration, status, and associated meta data.

id
string
required
read-only

Unique identifier for the workflow (uuidv7).

Example:

"01a1ff7c-a693-7998-a845-41b1856940d2"

name
string
required

The human-readable name of the workflow.

Example:

"My Workflow"

organization_id
string
required
read-only

ID of the organization this workflow belongs to.

Example:

"org-1"

status
number
required

The status of the workflow (0 = draft, 1 = active, 2 = paused).

Example:

1

timestamp_created
string
required
read-only

Timestamp when the workflow was created.

Example:

"2026-11-21T19:02:01.619Z"

timestamp_updated
string
required
read-only

Timestamp when the workflow was last updated.

Example:

"2026-11-21T19:02:01.619Z"

flow
object

The workflow configuration storing nodes and edges.

Example:
meta
object
read-only

Additional meta information for the workflow (e.g., associated apps, run statistics).

pause_reason
null | string
read-only

Reason the workflow was paused (e.g. "out_of_credits"). Null when not paused or paused manually.

Example:

"out_of_credits"