Skip to main content
POST
/
api
/
crews
/
run
/
custom
Run Custom Crew
curl --request POST \
  --url https://api.example.com/api/crews/run/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "crew_config": {
    "agents": [
      {
        "role": "<string>",
        "goal": "<string>",
        "backstory": "<string>",
        "id": "<string>",
        "verbose": false,
        "allow_delegation": false,
        "tools": [],
        "use_default_mcps": true
      }
    ],
    "tasks": [
      {
        "description": "<string>",
        "agent_index": 0,
        "expected_output": "",
        "tools": []
      }
    ],
    "id": "<string>",
    "verbose": false,
    "process": "sequential"
  },
  "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

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

crew_config
CrewConfig · object
required

Configuration model for a CrewAI crew with agents and tasks.

Attributes: id (str | None): Optional unique identifier for the crew. agents (List[AgentConfig]): List of agent configurations that make up the crew. tasks (List[TaskConfig]): List of task configurations to be executed by the crew. verbose (bool): Whether to enable detailed logging output. Defaults to False. process (str): Execution process type for tasks. Defaults to "sequential".

task_input
Task Input · object

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