POST /kickoff

Start a crew execution

POST /kickoff

cURL

travel_planning

curl --request POST \
  --url https://your-actual-crew-name.crewai.com/kickoff \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "budget": "1000 USD",
    "interests": "games, tech, ai, relaxing hikes, amazing food",
    "duration": "7 days",
    "age": "35"
  },
  "meta": {
    "requestId": "travel-req-123",
    "source": "web-app"
  }
}
'

200

Example

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

Authorizations

Authorization · string · header · required

📋 Reference Documentation - The tokens shown in examples are placeholders for reference only.

Use your actual Bearer Token or User Bearer Token from the CrewAI AMP dashboard for real API calls.

Bearer Token: Organization-level access for full crew operations User Bearer Token: User-scoped access with limited permissions

Body

application/json

inputs · object · required

Key-value pairs of all required inputs for your crew

Show child attributes

Example:

{
  "budget": "1000 USD",
  "interests": "games, tech, ai, relaxing hikes, amazing food",
  "duration": "7 days",
  "age": "35"
}

meta · object

Additional metadata to pass to the crew

Example:

{
  "requestId": "user-request-12345",
  "source": "mobile-app"
}

restoreFromStateId · string<uuid>

State id of a previous @persist flow execution to hydrate from. The new run forks from the referenced snapshot: state is restored, then the execution proceeds under a fresh state id (the source run's history is preserved). If the referenced state id is unknown, the run silently starts as a fresh session — no error is returned. See the inputs.id deprecation guide for migration details and operational notes.

Example:

"123e4567-e89b-42d3-a456-426614174000"

taskWebhookUrl · string<uri>

Callback URL executed after each task completion

Example:

"https://your-server.com/webhooks/task"

stepWebhookUrl · string<uri>

Callback URL executed after each agent thought/action

Example:

"https://your-server.com/webhooks/step"

crewWebhookUrl · string<uri>

Callback URL executed when the crew execution completes

Example:

"https://your-server.com/webhooks/crew"

Response

200

application/json

Crew execution started successfully

kickoff_id · string<uuid>

Unique identifier for tracking this execution

Example:

"abcd1234-5678-90ef-ghij-klmnopqrstuv"