Skip to main content
POST
/
workflows
Create Workflow
curl --request POST \
  --url https://api.example.com/workflows \
  --header 'Content-Type: multipart/form-data' \
  --cookie fastapiusersauth= \
  --form 'title=<string>' \
  --form 'description=<string>' \
  --form use_workflow_id=false \
  --form 'file=<string>' \
  --form file.0='@example-file'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "icon_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "version": 123,
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>"
    }
  ],
  "alias": "<string>",
  "error_handler": "<string>",
  "latest_definition": {
    "id": "<string>",
    "version": 123,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

fastapiusersauth
string
cookie
required

Query Parameters

workspace_id
string<uuid>
required

Body

multipart/form-data
title
string | null
Required string length: 1 - 100
description
string | null
Maximum string length: 1000
use_workflow_id
boolean
default:false

Use the workflow ID if it is provided in the YAML file

file
file | null

Response

Successful Response

id
string
required
title
string
required
description
string
required
status
string
required
icon_url
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
version
integer | null
required
tags
TagRead · object[] | null
alias
string | null
error_handler
string | null
latest_definition
WorkflowDefinitionReadMinimal · object