Skip to main content
POST
/
v1
/
workflow-definitions
Create Workflow Definition Handler
curl --request POST \
  --url http://localhost:8000/v1/workflow-definitions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "runner_type": "SELF_HOSTED",
  "source_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "instruction_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "output_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "runner_config": {
    "url": "<string>",
    "webhook_secret": "<string>"
  },
  "max_run_duration_seconds": 300,
  "template_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "runner_type": "SELF_HOSTED",
  "runner_config": {
    "url": "<string>"
  },
  "max_run_duration_seconds": 123,
  "source_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "instruction_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "output_path_part_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "template_path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

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
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