跳转到主要内容

​
CrewAI AOP API

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

​
快速入门

1

获取您的 API 凭据

在 CrewAI AOP 控制面板中导航到您的 Crew 详情页面，从“状态”选项卡复制您的 Bearer Token。
2

发现所需输入

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

启动 Crew 执行

使用您的输入调用 POST /kickoff 以启动 Crew 执行并接收 kickoff_id。
4

监控进度

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

​
认证

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

​
Token 类型

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

​
基本 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 Token
404未找到 - 资源不存在
422验证错误 - 缺少必需输入
500服务器错误 - 联系支持

​
交互式测试

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

​
要测试您的实际 API

复制 cURL 示例

复制 cURL 示例并用您的实际值替换 URL + Token

使用 Postman/Insomnia

将示例导入您首选的 API 测试工具
示例工作流
  1. 从任何端点页面复制此 cURL 示例
  2. 将 your-actual-crew-name.crewai.com 替换为您的实际 Crew URL
  3. 用控制面板中的实际 Bearer Token 替换 Bearer Token
  4. 在您的终端或 API 客户端中运行请求

​
需要帮助？

企业支持

获取 API 集成和故障排除方面的帮助

企业控制面板

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