Skip to main content
POST
Run custom crew

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-correlation-id
string | null

Optional UUID for this run. If you omit it or send a non-UUID value, the server assigns one.

Body

application/json

Advanced mode: run a custom crew from a full CrewConfig.

crew_config
CrewConfig · object
required

The full crew definition to run.

task_input
Task Input · object | null

Values that fill the placeholders in your crew_config's task descriptions.

Response

Successful Response

Response returned after a crew run starts.

correlation_id
string
required

ID for the crew run.

status
enum<string>
default:pending

State of the run. Always pending here, since the run has only just started.

Available options:
pending,
running,
completed,
failed
message
string | null

Human-readable note about the run, such as which crew started.