API Reference

Workflows

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Instances

List of workflow instances

GET/accounts/{account_id}/workflows/{workflow_name}/instances

Get logs and status from instance

GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Create a new workflow instance

POST/accounts/{account_id}/workflows/{workflow_name}/instances

Batch create new Workflow instances

POST/accounts/{account_id}/workflows/{workflow_name}/instances/batch

ModelsExpand Collapse

InstanceListResponse = object { id, created_on, ended_on, 5 more }

id: string

maxLength100

minLength1

created_on: string

formatdate-time

ended_on: string

formatdate-time

modified_on: string

formatdate-time

started_on: string

formatdate-time

status: "queued" or "running" or "paused" or 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

version_id: string

formatuuid

workflow_id: string

formatuuid

InstanceGetResponse = object { end, error, output, 9 more }

end: string

formatdate-time

error: object { message, name }

message: string

name: string

output: string or number

One of the following:

string

number

params: unknown

queued: string

formatdate-time

start: string

formatdate-time

status: "queued" or "running" or "paused" or 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

step_count: number

steps: array of object { attempts, config, end, 5 more } or object { end, error, finished, 3 more } or object { trigger, type } or object { end, error, finished, 4 more }

One of the following:

object { attempts, config, end, 5 more }

attempts: array of object { end, error, start, success }

end: string

formatdate-time

error: object { message, name }

message: string

name: string

start: string

formatdate-time

success: boolean

config: object { retries, timeout }

retries: object { delay, limit, backoff }

delay: string or number

Specifies the delay duration.

One of the following:

string

number

limit: number

backoff: optional "constant" or "linear" or "exponential"

One of the following:

"constant"

"linear"

"exponential"

timeout: string or number

Specifies the timeout duration.

One of the following:

string

number

end: string

formatdate-time

name: string

output: string

start: string

formatdate-time

success: boolean

type: "step"

object { end, error, finished, 3 more }

end: string

formatdate-time

error: object { message, name }

message: string

name: string

finished: boolean

name: string

start: string

formatdate-time

type: "sleep"

object { trigger, type }

trigger: object { source }

source: string

type: "termination"

object { end, error, finished, 4 more }

end: string

formatdate-time

error: object { message, name }

message: string

name: string

finished: boolean

name: string

start: string

formatdate-time

type: "waitForEvent"

output: optional string

success: boolean

trigger: object { source }

source: "unknown" or "api" or "binding" or 2 more

One of the following:

"unknown"

"api"

"binding"

"event"

"cron"

versionId: string

formatuuid

InstanceCreateResponse = object { id, status, version_id, workflow_id }

id: string

maxLength100

minLength1

status: "queued" or "running" or "paused" or 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

version_id: string

formatuuid

workflow_id: string

formatuuid

InstanceBulkResponse = object { id, status, version_id, workflow_id }

id: string

maxLength100

minLength1

status: "queued" or "running" or "paused" or 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

version_id: string

formatuuid

workflow_id: string

formatuuid

InstancesStatus

Change status of instance

PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

ModelsExpand Collapse

StatusEditResponse = object { status, timestamp }

status: "queued" or "running" or "paused" or 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

timestamp: string

Accepts ISO 8601 with no timezone offsets and in UTC.

formatdate-time

InstancesEvents

Send event to instance

POST/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}

ModelsExpand Collapse

EventCreateResponse = unknown