如何用 API Key 调用 AutoGPT External API 查询 Agents 与 Blocks? 如何用 API Key 调用 AutoGPT External API 查询 Agents 与 Blocks【免费下载链接】AutoGPTAutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.项目地址: https://gitcode.com/GitHub_Trending/au/AutoGPT如果你已经有一个 AutoGPT Platform 账号并希望通过脚本或后端服务以编程方式读取平台数据——比如列出当前可用的所有 Blocks或查询 Agent Store 中的 Agents——而不是在网页界面里逐个点开那么 External API 的 API Key 认证就是最直接的路径。本文基于 External API Guide 和路由源码 routes.py 演示完整调用过程先验证 Key 是否有效再分别调用/blocks与/store/agents端点并根据返回的 JSON 判断调用是否成功。文档中的示例指向托管后端https://backend.agpt.co。准备条件按 api-guide.md 的说明你需要一个 API Key从 AutoGPT Platform 账号设置中生成Generate an API key from your AutoGPT Platform account settings。API Key 适合 server-to-server 集成、个人脚本和自动化、后端服务这三类场景。能发 HTTP 请求的工具文档 Quick Start 使用curl任意支持自定义请求头的 HTTP 客户端均可。所有请求都带同一个认证头GET /external-api/v1/blocks X-API-Key: your_api_key_here其中your_api_key_here替换为你的 API Key。关于权限/blocks端点在源码中受READ_BLOCK权限保护见 routes.py。文档列出的 Scope 与权限对照表如下供你核对 Key 是否具备对应权限Scope说明IDENTITY读取用户 ID、邮箱、时区EXECUTE_GRAPH运行 agentsREAD_GRAPH读取 agent 运行结果EXECUTE_BLOCK运行单个 blockREAD_BLOCK读取 block 定义READ_STORE访问 agent storeUSE_TOOLS使用平台工具MANAGE_INTEGRATIONS创建和更新用户集成READ_INTEGRATIONS读取用户集成状态DELETE_INTEGRATIONS删除用户集成第一步用 /me 端点验证 API Key 是否可用在查询数据之前先确认 Key 能通过认证。调用curl -H X-API-Key: YOUR_API_KEY \ https://backend.agpt.co/external-api/v1/me/me需要IDENTITY权限成功时返回当前 Key 对应用户的信息响应字段为id、name、email、timezone见 UserInfoResponse。文档给出的响应示例如下{ id: user-uuid, name: John Doe, email: johnexample.com, timezone: Europe/Amsterdam }上面的字段值是文档示例实际返回的是你自己账号的数据。能收到这段用户信息说明 Key 本身有效如果这一步失败后续的/blocks、/store/agents调用也不会有意义。查询 BlocksGET /external-api/v1/blocksapi-guide.md Quick Start 中的原始命令# List available blocks curl -H X-API-Key: YOUR_API_KEY \ https://backend.agpt.co/external-api/v1/blocks该端点返回当前平台所有未禁用not b.disabled的 block 定义列表每个条目是 block 的字典形式包含输入输出 schema 等定义信息实现见 routes.py。典型用途是在写自动化脚本前先拿到 block 的id和输入输出结构。查询 AgentsGET /external-api/v1/store/agents查询 Agents对应的是 Store 端点返回分页的 agent 列表并支持过滤和排序定义见 routes.py。支持以下查询参数参数用途featured只返回 featured agentscreator按创建者用户名过滤sorted_by按runs、rating、name或updated_at排序search_query按名称、副标题和描述搜索category按类别过滤page页码默认 1必须大于 0page_size每页数量默认 20必须大于 0基本调用使用默认分页curl -H X-API-Key: YOUR_API_KEY \ https://backend.agpt.co/external-api/v1/store/agents带过滤与排序的示例curl -H X-API-Key: YOUR_API_KEY \ https://backend.agpt.co/external-api/v1/store/agents?page1page_size20search_querydiscordsorted_byrunspage或page_size传小于等于 0 的值会返回 422Page must be greater than 0 / Page size must be greater than 0写脚本时注意参数校验。拿到列表后可以用创建者用户名和 agent 名称取单个 agent 的详情curl -H X-API-Key: YOUR_API_KEY \ https://backend.agpt.co/external-api/v1/store/agents/{username}/{agent_name}{username}和{agent_name}替换为列表返回中的实际值大小写会被自动转为小写匹配。同一组路由下还有GET /external-api/v1/store/creators分页创作者列表和GET /external-api/v1/store/creators/{username}创作者详情如果你的任务扩展到按创作者维度浏览可以按相同方式调用。结果验证与进一步核对成功判定/me返回用户信息 JSON、/blocks返回 block 定义数组、/store/agents返回分页 agent 数据即说明调用链路通了。交互核对完整的 Swagger 文档含请求/响应 schema位于https://backend.agpt.co/external-api/docs文档明确说明可以在 Swagger UI 中直接试调接口适合在写死脚本前先核对参数名和返回结构。各端点的响应模型如StoreAgentsResponse、StoreAgentDetails在 routes.py 中有对应声明遇到字段疑问时可直接对照源码。限制与替代路径API Key 与 OAuth 的分工API Key 适合以你自己账号身份批量读取数据如果你的应用需要以用户身份访问其 AutoGPT 资源第三方应用、SSO、用户级权限文档建议改用 OAuth 2.0详见 OAuth 集成指南。认证方式不同Authorization: Bearer agpt_xt_...但接口路径相同。端点范围本文只覆盖查询类调用。POST /blocks/{block_id}/execute会实际执行 block 并计费POST /graphs会创建 agent这两类写入/执行操作不在查询任务范围内需要时先对照文档确认计费与权限要求。文档中的所有 URL 均指向托管后端backend.agpt.co自托管实例的访问地址请参照 Getting Started 中对应服务的端口配置自行确定。下一步如果你的目标是执行而非只查询可以从 Swagger 文档入手按EXECUTE_GRAPH/EXECUTE_BLOCK权限核对 Key 配置后再做调用。【免费下载链接】AutoGPTAutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.项目地址: https://gitcode.com/GitHub_Trending/au/AutoGPT创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考