Skip to main content
POST
/
v1
/
workflows
Create Workflow
curl --request POST \
  --url https://api.cyberdesk.io/v1/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "main_prompt": "<string>",
  "name": "<string>",
  "output_schema": "<string>",
  "includes_file_exports": false,
  "is_webhooks_enabled": false
}
'
{
  "main_prompt": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "output_schema": "<string>",
  "includes_file_exports": false,
  "is_webhooks_enabled": false,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "includes_input_variables": false,
  "old_versions": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating a workflow

​
main_prompt
string
required
Minimum string length: 1
​
name
string | null
Maximum string length: 255
​
output_schema
string | null

JSON schema for output data transformation

​
includes_file_exports
boolean
default:false

Enable AI-based file export detection

​
is_webhooks_enabled
boolean
default:false

Send webhook on run completion

Response

Successful Response

Workflow response schema

​
main_prompt
string
required
Minimum string length: 1
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
name
string | null
Maximum string length: 255
​
output_schema
string | null

JSON schema for output data transformation

​
includes_file_exports
boolean
default:false

Enable AI-based file export detection

​
is_webhooks_enabled
boolean
default:false

Send webhook on run completion

​
user_id
string<uuid> | null
​
organization_id
string | null
​
includes_input_variables
boolean
default:false
​
old_versions
Old Versions · object[] | null