Skip to main content
POST
Create Workflow Definition Handler

Headers

authorization
string | null

Cookies

ks_uat
string | null

Body

application/json

Create a new workflow definition.

name
string
required
Maximum string length: 255
runner_type
enum<string>
required

Runner that executes the workflow.

Available options:
SELF_HOSTED
source_path_part_ids
string<uuid>[]
required
Required array length: 1 - 20 elements
instruction_path_part_ids
string<uuid>[]
required
Required array length: 1 - 20 elements
output_path_part_ids
string<uuid>[]
required
Required array length: 1 - 20 elements
description
string | null
runner_config
SelfHostedRunnerConfig · object | null

Configuration for self-hosted workflow runner.

max_run_duration_seconds
integer
default:300
Required range: 60 <= x <= 86400
template_path_part_id
string<uuid> | null

Response

Successful Response

Workflow definition response.

id
string<uuid>
required
name
string
required
description
string | null
required
runner_type
enum<string>
required

Runner that executes the workflow.

Available options:
SELF_HOSTED
runner_config
SelfHostedRunnerConfigResponse · object | null
required

Response-safe version of runner config — excludes webhook_secret.

max_run_duration_seconds
integer
required
source_path_part_ids
string<uuid>[]
required
instruction_path_part_ids
string<uuid>[]
required
output_path_part_ids
string<uuid>[]
required
template_path_part_id
string<uuid> | null
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required