Implementation:CrewAIInc CrewAI Enterprise API Spec En

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

Overview

English-locale version of the CrewAI AMP API OpenAPI 3.0.3 specification, serving as the explicit English translation of the enterprise API documentation.

Description

This YAML file is structurally identical to the base specification (enterprise-api.base.yaml) and contains the same 570 lines. It exists as the explicit English locale variant in the multi-language documentation system. While its content matches the base file, it is maintained as a separate locale-specific file with the .en.yaml suffix so that the documentation build system can serve it alongside Korean (.ko.yaml) and Brazilian Portuguese (.pt-BR.yaml) translations using a consistent locale-based file naming convention.

The file defines the same four core endpoints:

• GET /inputs -- Retrieve required input parameters for a crew
• POST /kickoff -- Start a new crew execution with provided inputs
• GET /{kickoff_id}/status -- Poll execution status and retrieve results
• POST /resume -- Resume paused execution with human feedback (HITL)

All descriptions, summaries, examples, error responses, and component schemas are in English and match the base file exactly.

Usage

This file enables language switching for the API reference section of the CrewAI documentation site. The documentation build system uses the .en suffix to route English-speaking users to this version of the API specification.

Code Reference

Source Location

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

Specification Header

openapi: 3.0.3
info:
  title: CrewAI AMP API
  description: |
    REST API for interacting with your deployed CrewAI crews on CrewAI AMP.
  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 the list of required input parameters
/kickoff	POST	startCrewExecution	Initiates a new crew execution with provided inputs
/{kickoff_id}/status	GET	getExecutionStatus	Retrieves current status and results of a crew execution
/resume	POST	resumeCrewExecution	Resumes a paused crew execution with human feedback

Component Schemas

Schema	Description
ExecutionRunning	Status "running" with current_task and progress counters
ExecutionCompleted	Status "completed" with result output, task array, and execution_time
ExecutionError	Status "error" with error message and execution_time
TaskResult	Individual task output with task_id, output, agent, and execution_time
Error	Standard error with error type and message
ValidationError	Validation error with missing_inputs detail

Usage Examples

Get Required Inputs

# GET /inputs
# Response 200:
inputs: ["budget", "interests", "duration", "age"]

Start Crew Execution

# POST /kickoff
# Request:
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"

Related Pages

• Principle:CrewAIInc_CrewAI_Project_Scaffolding