跳转到主要内容

​
CrewAI AMP API

欢迎来到 CrewAI AMP API 参考文档。此 API 允许您以编程方式与您部署的 Crew 进行交互，实现与您的应用程序、工作流和服务的集成。

​
快速入门

1

获取您的 API 凭证

在 CrewAI AMP 仪表板中导航至您的 Crew 详情页面，并从“状态”选项卡中复制您的 Bearer Token。
2

发现所需输入

使用 GET /inputs 端点查看您的 Crew 需要哪些参数。
3

开始执行 Crew

使用您的输入调用 POST /kickoff 以开始执行 Crew，并接收一个 kickoff_id。
4

监控进度

使用 GET /status/{kickoff_id} 检查执行状态并获取结果。

​
身份验证

所有 API 请求都需要使用 Bearer Token 进行身份验证。请将您的 Token 包含在 Authorization 标头中。 
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
  https://your-crew-url.crewai.com/inputs

​
令牌类型

令牌类型范围用例
Bearer 令牌组织级访问权限完整的 Crew 操作，适用于服务器到服务器的集成
用户 Bearer 令牌用户范围的访问权限权限受限，适用于特定用户的操作
您可以在 CrewAI AMP 仪表板中您 Crew 详情页的“状态”选项卡中找到这两种令牌。

​
基础 URL

每个部署的 Crew 都有其自己独特的 API 端点 
https://your-crew-name.crewai.com
请将 your-crew-name 替换为您在仪表板中实际的 Crew URL。

​
典型工作流程

  1. 发现：调用 GET /inputs 以了解您的 Crew 需要什么
  2. 执行：通过 POST /kickoff 提交输入以开始处理
  3. 监控：轮询 GET /status/{kickoff_id} 直至完成
  4. 结果：从已完成的响应中提取最终输出

​
错误处理

API 使用标准的 HTTP 状态码
代码含义
200成功
400错误请求 - 输入格式无效
401未授权 - Bearer 令牌无效
404未找到 - 资源不存在
422验证错误 - 缺少必需的输入
500服务器错误 - 请联系支持

​
交互式测试

为什么没有“发送”按钮？由于每个 CrewAI AMP 用户都有自己独特的 Crew URL，我们使用参考模式而非交互式操作平台，以避免混淆。这能向您准确展示请求应有的样子，而不会有无法工作的发送按钮。
每个端点页面都会向您展示
  • ✅ 包含所有参数的精确请求格式
  • ✅ 成功和错误情况下的响应示例
  • ✅ 多种语言（cURL、Python、JavaScript 等）的代码示例
  • ✅ 使用正确 Bearer 令牌格式的身份验证示例

​
要测试您的实际 API

复制 cURL 示例

复制 cURL 示例并将 URL + 令牌替换为您的真实值

使用 Postman/Insomnia

将示例导入您偏好的 API 测试工具
工作流程示例
  1. 从任意端点页面复制此 cURL 示例
  2. 将 your-actual-crew-name.crewai.com 替换为您的真实 Crew URL
  3. 将 Bearer 令牌替换为您从仪表板获取的真实令牌
  4. 在您的终端或 API 客户端中运行请求

​
需要帮助？

企业支持

获取 API 集成和问题排查方面的帮助

企业仪表板

管理您的 Crew 并查看执行日志
⌘我