Get Workflow

{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "actions": {},
  "object": {},
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook": {
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "<string>",
    "secret": "<string>",
    "status": "online",
    "allowlisted_cidrs": [
      "<string>"
    ],
    "filters": {},
    "methods": [
      "GET"
    ],
    "workflow_id": "<string>",
    "url": "<string>",
    "has_active_api_key": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "entrypoint_ref": "<string>",
    "api_key_preview": "<string>",
    "api_key_created_at": "2023-11-07T05:31:56Z",
    "api_key_last_used_at": "2023-11-07T05:31:56Z",
    "api_key_revoked_at": "2023-11-07T05:31:56Z"
  },
  "schedules": [
    {
      "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "every": "<string>",
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": "online",
      "cron": "<string>",
      "inputs": {},
      "offset": "<string>",
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "timeout": 123
    }
  ],
  "entrypoint": "<string>",
  "static_inputs": {},
  "returns": "<unknown>",
  "config": {
    "environment": "default",
    "timeout": 300
  },
  "version": 123,
  "expects": {},
  "alias": "<string>",
  "error_handler": "<string>"
}

GET

workflows

{workflow_id}

{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "actions": {},
  "object": {},
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "webhook": {
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "<string>",
    "secret": "<string>",
    "status": "online",
    "allowlisted_cidrs": [
      "<string>"
    ],
    "filters": {},
    "methods": [
      "GET"
    ],
    "workflow_id": "<string>",
    "url": "<string>",
    "has_active_api_key": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "entrypoint_ref": "<string>",
    "api_key_preview": "<string>",
    "api_key_created_at": "2023-11-07T05:31:56Z",
    "api_key_last_used_at": "2023-11-07T05:31:56Z",
    "api_key_revoked_at": "2023-11-07T05:31:56Z"
  },
  "schedules": [
    {
      "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "every": "<string>",
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": "online",
      "cron": "<string>",
      "inputs": {},
      "offset": "<string>",
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "timeout": 123
    }
  ],
  "entrypoint": "<string>",
  "static_inputs": {},
  "returns": "<unknown>",
  "config": {
    "environment": "default",
    "timeout": 300
  },
  "version": 123,
  "expects": {},
  "alias": "<string>",
  "error_handler": "<string>"
}

Authorizations

fastapiusersauth

string

required

Path Parameters

workflow_id

required

Query Parameters

workspace_id

string<uuid>

required

Response

Successful Response

string

required

title

string

required

description

string

required

status

string

required

actions

Actions · object

required

Show child attributes

actions.{key}

ActionRead · object

Show child attributes

actions.{key}.id

string

required

actions.{key}.type

string

required

actions.{key}.title

string

required

actions.{key}.description

string

required

actions.{key}.status

string

required

actions.{key}.inputs

string

required

actions.{key}.is_interactive

boolean

required

actions.{key}.control_flow

ActionControlFlow · object

Show child attributes

actions.{key}.control_flow.run_if

string | null

Maximum string length: 1000

actions.{key}.control_flow.for_each

string | null

Maximum string length: 1000

actions.{key}.control_flow.join_strategy

enum<string>

default:all

Available options:

any,

all

actions.{key}.control_flow.retry_policy

ActionRetryPolicy · object

Show child attributes

actions.{key}.control_flow.retry_policy.max_attempts

integer

default:1

Total number of execution attempts. 0 means unlimited, 1 means no retries.

actions.{key}.control_flow.retry_policy.timeout

integer

default:300

Timeout for the action in seconds.

actions.{key}.control_flow.retry_policy.retry_until

string | null

Retry until a specific condition is met.

actions.{key}.control_flow.start_delay

number

default:0

Delay before starting the action in seconds. If wait_until is also provided, the wait_until timer will take precedence.

actions.{key}.control_flow.wait_until

string | null

Wait until a specific date and time before starting. Overrides start_delay if both are provided.

actions.{key}.interaction

ResponseInteraction · object

An interaction configuration

ResponseInteraction
ApprovalInteraction

Show child attributes

actions.{key}.interaction.type

string

required

Allowed value: "response"

actions.{key}.interaction.timeout

number | null

The timeout for the interaction in seconds.

object

Object · object

required

owner_id

string<uuid>

required

webhook

WebhookRead · object

required

Show child attributes

webhook.owner_id

string<uuid>

required

webhook.id

string

required

webhook.secret

string

required

webhook.status

enum<string>

required

Available options:

online,

offline

webhook.allowlisted_cidrs

string[]

required

webhook.filters

Filters · object

required

webhook.methods

enum<string>[]

required

Available options:

GET,

POST

webhook.workflow_id

string

required

webhook.url

string

required

webhook.has_active_api_key

boolean

required

webhook.created_at

string<date-time>

webhook.updated_at

string<date-time>

webhook.entrypoint_ref

string | null

webhook.api_key_preview

string | null

webhook.api_key_created_at

string<date-time> | null

webhook.api_key_last_used_at

string<date-time> | null

webhook.api_key_revoked_at

string<date-time> | null

schedules

Schedule · object[]

required

Show child attributes

schedules.owner_id

string<uuid>

required

schedules.every

string<duration>

required

ISO 8601 duration string

schedules.workflow_id

string<uuid>

required

schedules.created_at

string<date-time>

schedules.updated_at

string<date-time>

schedules.id

string

schedules.status

string

default:online

schedules.cron

string | null

schedules.inputs

Inputs · object

schedules.offset

string<duration> | null

ISO 8601 duration string

schedules.start_at

string<date-time> | null

ISO 8601 datetime string

schedules.end_at

string<date-time> | null

ISO 8601 datetime string

schedules.timeout

number | null

The maximum number of seconds to wait for the workflow to complete

entrypoint

string | null

required

static_inputs

Static Inputs · object

required

returns

any

required

config

DSLConfig · object

required

This is the runtime configuration for the workflow.

Activities don't need access to this.

Show child attributes

config.environment

string

default:default

The workflow's target execution environment. This is used to isolate secrets across different environments.If not provided, the default environment (default) is used.

config.timeout

number

default:300

The maximum number of seconds to wait for the workflow to complete.

version

integer | null

expects

Expects · object

Show child attributes

expects.{key}

ExpectedField · object

Show child attributes

expects.{key}.type

string

required

expects.{key}.description

string | null

expects.{key}.default

unknown

alias

string | null

error_handler

string | null

Create Workflow

Delete Workflow

⌘I

REST API

Endpoints

Authorizations

Path Parameters

Query Parameters

Response