Complete reference for the CrewAI Enterprise REST API
Get Your API Credentials
Discover Required Inputs
GET /inputs
endpoint to see what parameters your crew expects.Start a Crew Execution
POST /kickoff
with your inputs to start the crew execution and receive a kickoff_id
.Monitor Progress
GET /status/{kickoff_id}
to check execution status and retrieve results.Authorization
header:
Token Type | Scope | Use Case |
---|---|---|
Bearer Token | Organization-level access | Full crew operations, ideal for server-to-server integration |
User Bearer Token | User-scoped access | Limited permissions, suitable for user-specific operations |
your-crew-name
with your actual crew’s URL from the dashboard.
GET /inputs
to understand what your crew needsPOST /kickoff
to start processingGET /status/{kickoff_id}
until completionCode | Meaning |
---|---|
200 | Success |
400 | Bad Request - Invalid input format |
401 | Unauthorized - Invalid bearer token |
404 | Not Found - Resource doesn’t exist |
422 | Validation Error - Missing required inputs |
500 | Server Error - Contact support |
your-actual-crew-name.crewai.com
with your real crew URL