跳转到主要内容

文档索引

获取完整文档索引: https://docs.crewai.com.cn/llms.txt

在深入了解之前,请使用此文件来浏览所有可用页面。

CrewAI AMP API

欢迎查阅 CrewAI AMP API 参考。此 API 允许您以编程方式与已部署的智能体团队(Crews)进行交互,从而实现与您的应用程序、工作流和服务的集成。

快速入门

1

获取 API 凭据

导航至 CrewAI AMP 控制面板中的团队详情页面,并从“状态”(Status)选项卡中复制您的 Bearer Token。
2

发现所需输入

使用 GET /inputs 端点查看您的团队所需的参数。
3

启动团队执行

调用 POST /kickoff 并传入您的输入,以启动团队执行并获取 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

Token 类型

Token 类型作用域用例
Bearer Token组织级访问权限完整的团队操作,非常适合服务器到服务器的集成
用户 Bearer Token用户级访问权限受限权限,适用于特定用户的操作
您可以在 CrewAI AMP 控制面板中团队详情页面的“状态”(Status)选项卡中找到这两种 token 类型。

基础 URL

每个已部署的团队都有其唯一的 API 端点
https://your-crew-name.crewai.com
your-crew-name 替换为您从控制面板获取的实际团队 URL。

典型工作流

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

错误处理

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

交互式测试

为什么没有“发送”按钮? 由于每位 CrewAI AMP 用户都有其唯一的团队 URL,我们使用参考模式而非交互式演示沙盒,以避免混淆。这能准确向您展示请求应有的样子,而不会提供无法实际使用的发送按钮。
每个端点页面为您显示
  • 确切的请求格式(包含所有参数)
  • 响应示例(包括成功和错误情况)
  • 代码示例(支持多种语言,如 cURL、Python、JavaScript 等)
  • 身份验证示例(包含正确的 Bearer token 格式)

测试您的实际 API

复制 cURL 示例

复制 cURL 示例,并将 URL 和 token 替换为您自己的实际值

使用 Postman/Insomnia

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

需要帮助?

企业支持

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

企业控制面板

管理您的团队并查看执行日志