Skip to main content
GET
/
api
/
crew-runs
/
{run_id}
Get Run
curl --request GET \
  --url https://api.example.com/api/crew-runs/{run_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "correlation_id": "<string>",
  "owner_id": "<string>",
  "status": "pending",
  "created_at": "<string>",
  "crew_type": "<string>",
  "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": {},
  "result": "<string>",
  "error": "<string>",
  "started_at": "<string>",
  "completed_at": "<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.

Path Parameters

​
run_id
string<uuid>
required

Response

Successful Response

Persistent crew run record returned from the history API.

​
id
string
required
​
correlation_id
string
required
​
owner_id
string
required
​
status
enum<string>
required
Available options:
pending,
running,
completed,
failed
​
created_at
string
required
​
crew_type
string | null
​
crew_config
CrewConfig · object

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
​
result
string | null
​
error
string | null
​
started_at
string | null
​
completed_at
string | null