Introduction
Complete reference for the CrewAI Enterprise REST API
CrewAI Enterprise API
Welcome to the CrewAI Enterprise API reference. This API allows you to programmatically interact with your deployed crews, enabling integration with your applications, workflows, and services.
Quick Start
Get Your API Credentials
Navigate to your crew’s detail page in the CrewAI Enterprise dashboard and copy your Bearer Token from the Status tab.
Discover Required Inputs
Use the GET /inputs endpoint to see what parameters your crew expects.
Start a Crew Execution
Call POST /kickoff with your inputs to start the crew execution and receive a kickoff_id.
Monitor Progress
Use GET /status/{kickoff_id} to check execution status and retrieve results.
Authentication
All API requests require authentication using a Bearer token. Include your token in the Authorization header:
Token Types
| 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 |
You can find both token types in the Status tab of your crew’s detail page in the CrewAI Enterprise dashboard.
Base URL
Each deployed crew has its own unique API endpoint:
Replace your-crew-name with your actual crew’s URL from the dashboard.
Typical Workflow
- Discovery: Call
GET /inputsto understand what your crew needs - Execution: Submit inputs via
POST /kickoffto start processing - Monitoring: Poll
GET /status/{kickoff_id}until completion - Results: Extract the final output from the completed response
Error Handling
The API uses standard HTTP status codes:
| Code | 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 |
Interactive Testing
Why no “Send” button? Since each CrewAI Enterprise user has their own unique crew URL, we use reference mode instead of an interactive playground to avoid confusion. This shows you exactly what the requests should look like without non-functional send buttons.
Each endpoint page shows you:
- ✅ Exact request format with all parameters
- ✅ Response examples for success and error cases
- ✅ Code samples in multiple languages (cURL, Python, JavaScript, etc.)
- ✅ Authentication examples with proper Bearer token format
To Test Your Actual API:
Copy cURL Examples
Copy the cURL examples and replace the URL + token with your real values
Use Postman/Insomnia
Import the examples into your preferred API testing tool
Example workflow:
- Copy this cURL example from any endpoint page
- Replace
your-actual-crew-name.crewai.comwith your real crew URL - Replace the Bearer token with your real token from the dashboard
- Run the request in your terminal or API client
Need Help?
Enterprise Support
Get help with API integration and troubleshooting
Enterprise Dashboard
Manage your crews and view execution logs
Introduction
Complete reference for the CrewAI Enterprise REST API
CrewAI Enterprise API
Welcome to the CrewAI Enterprise API reference. This API allows you to programmatically interact with your deployed crews, enabling integration with your applications, workflows, and services.
Quick Start
Get Your API Credentials
Navigate to your crew’s detail page in the CrewAI Enterprise dashboard and copy your Bearer Token from the Status tab.
Discover Required Inputs
Use the GET /inputs endpoint to see what parameters your crew expects.
Start a Crew Execution
Call POST /kickoff with your inputs to start the crew execution and receive a kickoff_id.
Monitor Progress
Use GET /status/{kickoff_id} to check execution status and retrieve results.
Authentication
All API requests require authentication using a Bearer token. Include your token in the Authorization header:
Token Types
| 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 |
You can find both token types in the Status tab of your crew’s detail page in the CrewAI Enterprise dashboard.
Base URL
Each deployed crew has its own unique API endpoint:
Replace your-crew-name with your actual crew’s URL from the dashboard.
Typical Workflow
- Discovery: Call
GET /inputsto understand what your crew needs - Execution: Submit inputs via
POST /kickoffto start processing - Monitoring: Poll
GET /status/{kickoff_id}until completion - Results: Extract the final output from the completed response
Error Handling
The API uses standard HTTP status codes:
| Code | 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 |
Interactive Testing
Why no “Send” button? Since each CrewAI Enterprise user has their own unique crew URL, we use reference mode instead of an interactive playground to avoid confusion. This shows you exactly what the requests should look like without non-functional send buttons.
Each endpoint page shows you:
- ✅ Exact request format with all parameters
- ✅ Response examples for success and error cases
- ✅ Code samples in multiple languages (cURL, Python, JavaScript, etc.)
- ✅ Authentication examples with proper Bearer token format
To Test Your Actual API:
Copy cURL Examples
Copy the cURL examples and replace the URL + token with your real values
Use Postman/Insomnia
Import the examples into your preferred API testing tool
Example workflow:
- Copy this cURL example from any endpoint page
- Replace
your-actual-crew-name.crewai.comwith your real crew URL - Replace the Bearer token with your real token from the dashboard
- Run the request in your terminal or API client
Need Help?
Enterprise Support
Get help with API integration and troubleshooting
Enterprise Dashboard
Manage your crews and view execution logs