主题
概述
CrewAI AMP REST API 完整参考
CrewAI AMP API
欢迎查阅 CrewAI AMP API 参考文档。通过此 API，你可以用编程方式与已部署的团队进行交互，从而实现与你的应用、工作流和服务的集成。
快速开始
Get Your API Credentials
在 CrewAI AMP 仪表盘中进入团队的详情页，然后从 Status 标签页复制你的 Bearer Token。
Discover Required Inputs
使用 GET /inputs 端点查看你的团队需要哪些参数。
Start a Crew Execution
携带你的输入调用 POST /kickoff 以启动团队执行，并获得 一个 kickoff_id。
Monitor Progress
使用 GET /status/{kickoff_id} 查看执行状态并获取结果。
身份认证
所有 API 请求都需要使用 Bearer token 进行身份认证。请在 Authorization 请求头中包含你的 token：
bash
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
https://your-crew-url.crewai.com/inputsToken 类型
| Token 类型 | 作用域 | 使用场景 |
|---|---|---|
| Bearer Token | 组织级访问权限 | 完整的团队操作，适合服务器到服务器的集成 |
| User Bearer Token | 用户级访问权限 | 权限受限，适合针对特定用户的操作 |
TIP
你可以在 CrewAI AMP 仪表盘中团队详情页的 Status 标签页里找到这两种 token。
基础 URL
每个已部署的团队都有自己唯一的 API 端点：
https://your-crew-name.crewai.com请将 your-crew-name 替换为仪表盘中显示的实际团队 URL。
典型工作流
- 发现：调用
GET /inputs了解你的团队需要哪些输入 - 执行：通过
POST /kickoff提交输入以开始处理 - 监控：轮询
GET /status/{kickoff_id}直到完成 - 结果：从已完成的响应中提取最终输出
错误处理
该 API 使用标准 HTTP 状态码：
| 状态码 | 含义 |
|---|---|
200 | 成功 |
400 | 错误请求 - 输入格式无效 |
401 | 未授权 - bearer token 无效 |
404 | 未找到 - 资源不存在 |
422 | 校验错误 - 缺少必填输入 |
500 | 服务器错误 - 请联系支持人员 |
交互式测试
INFO
为什么没有「发送」按钮？ 由于每位 CrewAI AMP 用户都有各自唯一的团队 URL，我们改用参考模式而非交互式演练场，以避免 造成混淆。这样你可以准确看到请求应该是什么样子，而不会出现 无法使用的发送按钮。
每个端点页面都会展示：
- ✅ 精确的请求格式，包含所有参数
- ✅ 响应示例，涵盖成功与错误场景
- ✅ 多种语言的代码示例（cURL、Python、JavaScript 等）
- ✅ 身份认证示例，包含正确的 Bearer token 格式
要测试你自己的实际 API：
Copy cURL Examples
复制 cURL 示例，并将 URL 与 token 替换为你的真实值
Use Postman/Insomnia
将示例导入你常用的 API 测试工具
示例工作流：
- 从任意端点页面复制此 cURL 示例
- 将
your-actual-crew-name.crewai.com替换为你真实的团队 URL - 将 Bearer token 替换为仪表盘中你的真实 token
- 运行该请求，在你的终端或 API 客户端中