Skip to main content
POST
Run preset 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

Simple mode: run a preset crew type with a task input.

crew_type
enum<string>
required

The preset crew type to run.

Available options:
ask,
classification,
data_engineering,
data_suggestion,
semantic_model,
policy_suggestion
task_input
Task Input · object

Key-value inputs passed to the crew. For example, {'question': '...'}.

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.