Skip to main content
POST
Create workflow

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