API Reference

Workflows

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Versions

List deployed Workflow versions

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

Get Workflow version details

GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}

Get Workflow version graph

GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph

ModelsExpand Collapse

VersionListResponse object { id, class_name, created_on, 7 more }

id: string

formatuuid

class_name: string

created_on: string

formatdate-time

has_dag: boolean

language: "javascript" or "python"

The programming language of the workflow implementation.

One of the following:

"javascript"

"python"

modified_on: string

formatdate-time

workflow_id: string

formatuuid

concurrency: optional object { limit }

limit: optional number

Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.

maximum9007199254740991

minimum1

default_retention: optional object { error_retention, success_retention }

error_retention: optional number

Default error retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

success_retention: optional number

Default success retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

limits: optional object { steps }

steps: optional number

maximum9007199254740991

minimum1

VersionGetResponse object { id, class_name, created_on, 7 more }

id: string

formatuuid

class_name: string

created_on: string

formatdate-time

has_dag: boolean

language: "javascript" or "python"

The programming language of the workflow implementation.

One of the following:

"javascript"

"python"

modified_on: string

formatdate-time

workflow_id: string

formatuuid

concurrency: optional object { limit }

limit: optional number

Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.

maximum9007199254740991

minimum1

default_retention: optional object { error_retention, success_retention }

error_retention: optional number

Default error retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

success_retention: optional number

Default success retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

limits: optional object { steps }

steps: optional number

maximum9007199254740991

minimum1

VersionGraphResponse object { id, class_name, created_on, 3 more }

id: string

formatuuid

class_name: string

created_on: string

formatdate-time

graph: object { version, workflow }

Versioned workflow graph payload.

version: number

workflow: object { class_name, functions, nodes, payload }

A parsed workflow entrypoint with its step graph.

class_name: string

functions: map[object { name, nodes, type } ]

name: string

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

nodes: array of object { duration, name, type, 2 more } or object { config, name, nodes, 3 more } or object { name, options, type, 3 more } or 11 more

One of the following:

object { duration, name, type, 2 more }

duration: number or string

Duration as milliseconds (number) or human-readable string.

One of the following:

number

string

name: string

type: "step_sleep"

resolves: optional number

starts: optional number

object { config, name, nodes, 3 more }

config: object { retries, timeout }

Configuration for a step (retries and timeout).

retries: object { backoff, delay, limit }

Retry policy for a step.

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

Backoff strategy for step retries.

One of the following:

"constant"

"linear"

"exponential"

delay: number or string

Duration as milliseconds (number) or human-readable string.

One of the following:

number

string

limit: number

timeout: number or string

Duration as milliseconds (number) or human-readable string.

One of the following:

number

string

name: string

nodes: array of unknown

Child nodes (recursive).

type: "step_do"

resolves: optional number

starts: optional number

object { name, options, type, 3 more }

name: string

options: object { event_type, timeout }

Options for a waitForEvent step.

event_type: string

timeout: number or string

Duration as milliseconds (number) or human-readable string.

One of the following:

number

string

type: "step_wait_for_event"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

resolves: optional number

starts: optional number

object { name, timestamp, type, 2 more }

name: string

timestamp: string

type: "step_sleep_until"

resolves: optional number

starts: optional number

object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "loop"

object { kind, nodes, type }

kind: "all" or "any" or "all_settled" or "race"

Parallel execution strategy.

One of the following:

"all"

"any"

"all_settled"

"race"

nodes: array of unknown

Child nodes (recursive).

type: "parallel"

object { catch_block, finally_block, try_block, type }

catch_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

finally_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

try_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

type: "try"

object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

object { branches, type }

branches: array of object { condition, nodes }

condition: string

nodes: array of unknown

Child nodes (recursive).

type: "if"

object { branches, discriminant, type }

branches: array of object { condition, nodes }

condition: string

nodes: array of unknown

Child nodes (recursive).

discriminant: string

type: "switch"

object { class_name, functions, nodes, 2 more }

class_name: string

functions: map[object { name, nodes, type } ]

name: string

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

nodes: array of unknown

Child nodes (recursive).

type: "start"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

object { name, type, resolves, starts }

name: string

type: "function_call"

resolves: optional number

starts: optional number

object { name, nodes, type }

name: string

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

object { kind, type }

kind: "break" or "return"

Break or return from a loop.

One of the following:

"break"

"return"

type: "break"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

modified_on: string

formatdate-time

workflow_id: string

formatuuid