Implementation:CrewAIInc CrewAI Enterprise API Spec Base

Knowledge Sources	CrewAI
Domains	API_Specification, Documentation
Last Updated	2026-02-11 00:00 GMT

Overview

Base (default/English) OpenAPI 3.0.3 specification for the CrewAI AMP (Agent Management Platform) REST API, documenting all endpoints for interacting with deployed CrewAI crews.

Description

This YAML file defines the canonical API reference for the CrewAI enterprise platform's REST interface. It serves as the base locale file from which localized versions (English, Korean, Portuguese) are derived. The specification enables automatic API documentation generation (via Swagger UI or Redoc) and client SDK generation.

The specification includes:

• Info block: API title "CrewAI AMP API", version 1.0.0, description with getting-started instructions, authentication details (Bearer Token and User Bearer Token), and contact information.
• Servers block: Placeholder URLs that users replace with their actual deployed crew URLs (e.g., https://your-actual-crew-name.crewai.com).
• Security: Global BearerAuth requirement with two token types -- organization-level Bearer Token and user-scoped User Bearer Token.
• Paths: Four core endpoints defining the complete crew execution lifecycle.
• Components: Reusable schemas (ExecutionRunning, ExecutionCompleted, ExecutionError, TaskResult, Error, ValidationError) and standard error responses.

Usage

This file is used by the documentation build system to render the API Reference tab in the CrewAI documentation site. It provides the authoritative contract for how external systems programmatically interact with deployed CrewAI crews through the kickoff-status-polling workflow.

Code Reference

Source Location

• Repository: CrewAI
• File: docs/enterprise-api.base.yaml
• Lines: 1-570

Specification Version

openapi: 3.0.3
info:
  title: CrewAI AMP API
  version: 1.0.0
  contact:
    name: CrewAI Support
    email: support@crewai.com
    url: https://crewai.com

I/O Contract

API Endpoints

Endpoint	Method	Operation ID	Description
/inputs	GET	getRequiredInputs	Retrieves required input parameters for a crew
/kickoff	POST	startCrewExecution	Starts a new crew execution with provided inputs
/{kickoff_id}/status	GET	getExecutionStatus	Polls execution status and retrieves results
/resume	POST	resumeCrewExecution	Resumes paused execution with human feedback (HITL)

Kickoff Request Schema

Name	Type	Required	Description
inputs	object	Yes	Key-value pairs of required crew inputs
meta	object	No	Additional metadata to pass to the crew
taskWebhookUrl	string (URI)	No	Callback URL after each task completion
stepWebhookUrl	string (URI)	No	Callback URL after each agent thought/action
crewWebhookUrl	string (URI)	No	Callback URL when crew execution completes

Execution Status Responses

Status	Schema	Description
running	ExecutionRunning	Execution in progress with current task info and progress
completed	ExecutionCompleted	Execution finished with full results, task outputs, and execution time
error	ExecutionError	Execution failed with error message and time until error

Resume Request Schema

Name	Type	Required	Description
execution_id	string (UUID)	Yes	Unique identifier for the crew execution
task_id	string	Yes	ID of the task requiring human feedback
human_feedback	string	Yes	Feedback on the task output
is_approve	boolean	Yes	Whether to approve (continue) or reject (retry) the task
taskWebhookUrl	string (URI)	No	Must be re-provided to continue receiving task notifications
stepWebhookUrl	string (URI)	No	Must be re-provided to continue receiving step notifications
crewWebhookUrl	string (URI)	No	Must be re-provided to receive completion notification

Usage Examples

Workflow: Discover Inputs, Kickoff, and Poll Status

# Step 1: GET /inputs
# Response: { "inputs": ["budget", "interests", "duration", "age"] }

# Step 2: POST /kickoff
# Body: { "inputs": { "budget": "1000 USD", "interests": "tech, ai", "duration": "7 days", "age": "35" } }
# Response: { "kickoff_id": "abcd1234-5678-90ef-ghij-klmnopqrstuv" }

# Step 3: GET /abcd1234-5678-90ef-ghij-klmnopqrstuv/status
# Response: { "status": "completed", "result": { "output": "..." }, "execution_time": 108.5 }

Related Pages

• Principle:CrewAIInc_CrewAI_Project_Scaffolding