Skip to main content
POST
/
workflows
Create workflow
curl --request POST \
  --url https://felix.so/api/v1/workflows \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "status": "planning",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key authentication. Get your key from Settings → API Keys.

Body

application/json
​
prompt
string
required

The main workflow description — what should this workflow do? The planning agent will use this to design and build the workflow.

Minimum string length: 1
​
name
string

Workflow name. Defaults to auto-generated.

Minimum string length: 1
​
description
string

Workflow description.

Response

Workflow created and planning started

​
id
string<uuid>
required

Unique workflow identifier

​
name
string
required

Workflow name

​
description
string
required

Workflow description

​
url
string<uri>
required

URL to view the workflow in the Felix UI

​
status
enum<string>
required

Workflow status — the planning agent has been started

Available options:
planning
​
created_at
string<date-time>
required

Timestamp when the workflow was created