Skip to main content
POST
/
api
/
crews
/
run
Run Preset Crew
curl --request POST \
  --url https://api.example.com/api/crews/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "crew_type": "ask",
  "task_input": {}
}
'
{
  "correlation_id": "<string>",
  "status": "pending",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json

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

​
crew_type
enum<string>
required

Available preset crew types.

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

Key-value inputs passed to the crew (e.g. {'question': '...'})

Response

Successful Response

Response returned when a crew run is initiated.

​
correlation_id
string
required
​
status
enum<string>
default:pending
Available options:
pending,
running,
completed,
failed
​
message
string | null