v1

latestOpenAPI 3.0.32026-07-264616.2 KB

Start Crew Execution

📋 Reference Example Only - This shows the request format. To test with your actual crew, copy the cURL example and replace the URL + token with your real values.

Initiates a new crew execution with the provided inputs. Returns a kickoff ID that can be used to track the execution progress and retrieve results.

Crew executions can take anywhere from seconds to minutes depending on their complexity. Consider using webhooks for real-time notifications or implement polling with the status endpoint.

post/kickoff

Request body

inputsobject required

Key-value pairs of all required inputs for your crew

metaobject

Additional metadata to pass to the crew

taskWebhookUrlstring uri

Callback URL executed after each task completion

stepWebhookUrlstring uri

Callback URL executed after each agent thought/action

crewWebhookUrlstring uri

Callback URL executed when the crew execution completes

Example request

{
  "inputs": {
    "budget": "1000 USD",
    "interests": "games, tech, ai, relaxing hikes, amazing food",
    "duration": "7 days",
    "age": "35"
  },
  "meta": {
    "requestId": "user-request-12345",
    "source": "mobile-app"
  },
  "taskWebhookUrl": "https://your-server.com/webhooks/task",
  "stepWebhookUrl": "https://your-server.com/webhooks/step",
  "crewWebhookUrl": "https://your-server.com/webhooks/crew"
}

Response

Crew execution started successfully

kickoff_idstring uuid

Unique identifier for tracking this execution

Example response

{
  "kickoff_id": "abcd1234-5678-90ef-ghij-klmnopqrstuv"
}