Auto-GPT-ZH API 完全参考开发者集成与二次开发指南【免费下载链接】Auto-GPT-ZHAuto-GPT中文版本及爱好者组织 同步更新原项目 AI领域创业 自媒体组织 用AI工作学习创作变现项目地址: https://gitcode.com/gh_mirrors/au/Auto-GPT-ZHAuto-GPT-ZH是一个功能强大的AI代理平台提供了丰富的API接口支持开发者进行集成和二次开发。本文将详细介绍Auto-GPT-ZH的API体系结构、核心功能接口、认证授权机制以及实际应用示例帮助开发者快速上手并充分利用平台 capabilities。Auto-GPT-ZH平台架构示意图展示了API服务与各功能模块的关系API架构概览Auto-GPT-ZH采用现代化的API架构设计基于FastAPI构建提供RESTful风格的接口。API服务主要包含以下几个核心模块v1 API提供图(graph)管理、块(block)执行、积分管理等核心功能v2 API包含商店(store)、库(library)等高级功能接口WebSocket API支持实时通信用于监控执行状态和接收事件通知API服务的入口文件位于autogpt_platform/backend/backend/server/rest_api.py其中定义了API路由的注册和主要配置。快速开始环境准备首先克隆Auto-GPT-ZH仓库到本地git clone https://gitcode.com/gh_mirrors/au/Auto-GPT-ZH cd Auto-GPT-ZH按照项目文档安装依赖并启动服务。成功启动后API服务默认运行在http://localhost:8000可以通过访问http://localhost:8000/docs查看交互式API文档。基础认证Auto-GPT-ZH API使用Bearer令牌进行认证。获取令牌后在请求头中包含以下信息Authorization: Bearer YOUR_ACCESS_TOKEN核心API接口1. 图(Graph)管理API图(Graph)是Auto-GPT-ZH的核心概念代表一个AI工作流或代理。以下是主要的图管理接口获取所有图GET /api/graphs返回当前用户创建的所有图的列表。创建新图POST /api/graphs请求体示例{ graph: { nodes: [ { id: node-1, type: llm, data: { prompt: 你是一个AI助手 } } ], edges: [] } }创建新图的实现逻辑位于autogpt_platform/backend/backend/server/routers/v1.py中的create_new_graph函数。执行图POST /api/graphs/{graph_id}/execute/{graph_version}启动一个图的执行返回执行ID用于后续查询状态。Auto-GPT-ZH图执行流程图展示了从提交执行到获取结果的完整流程2. 块(Block)管理API块(Block)是图中的基本功能单元如LLM调用、工具集成等。获取所有块类型GET /api/blocks返回系统中可用的所有块类型及其配置信息。执行特定块POST /api/blocks/{block_id}/execute直接执行单个块用于测试和调试。3. 积分(Credits)管理APIAuto-GPT-ZH使用积分系统管理资源使用相关API包括查询积分余额GET /api/credits充值积分POST /api/credits获取交易历史GET /api/credits/transactions4. API密钥管理为方便第三方应用集成Auto-GPT-ZH支持创建API密钥创建API密钥POST /api/api-keys请求体示例{ name: 我的应用密钥, permissions: [graph:read, graph:execute], description: 用于我的AI助手应用 }列出所有API密钥GET /api/api-keysAPI密钥管理的相关实现位于autogpt_platform/backend/backend/server/routers/v1.py的API Key部分。高级功能1. 计划任务(Schedule)Auto-GPT-ZH支持基于Cron表达式的定时执行功能POST /api/schedules请求体示例{ cron: 0 * * * *, input_data: {}, graph_id: your-graph-id, graph_version: 1 }2. 库(Library)管理v2 API提供了库功能用于管理可复用的代理模板GET /api/library/agents POST /api/library/agents GET /api/library/presets相关实现位于autogpt_platform/backend/backend/server/v2/library/routes.py。3. 商店(Store) API通过商店API可以分享和获取社区创建的代理GET /api/store/agents POST /api/store/submissions商店模块的详细文档位于autogpt_platform/backend/backend/server/v2/store/README.md。错误处理Auto-GPT-ZH API使用标准HTTP状态码表示请求结果200: 请求成功400: 请求参数错误401: 未授权403: 权限不足404: 资源不存在500: 服务器内部错误错误响应格式{ message: 错误描述, detail: 详细错误信息 }实际应用示例示例1创建并执行一个简单的AI代理import requests BASE_URL http://localhost:8000/api TOKEN your-auth-token headers {Authorization: fBearer {TOKEN}} # 创建一个简单的LLM代理 graph_data { graph: { nodes: [ { id: llm-node, type: llm, data: { prompt: 你是一个帮助用户写邮件的助手。用户输入邮件主题你返回邮件内容。 }, inputs: [{name: subject}], outputs: [{name: email_content}] } ], edges: [] } } # 创建图 response requests.post(f{BASE_URL}/graphs, jsongraph_data, headersheaders) graph response.json() graph_id graph[id] graph_version graph[version] # 执行图 execution_data {node_input: {subject: 请假申请}} response requests.post( f{BASE_URL}/graphs/{graph_id}/execute/{graph_version}, jsonexecution_data, headersheaders ) execution_id response.json()[graph_exec_id] # 获取执行结果 response requests.get( f{BASE_URL}/graphs/{graph_id}/executions/{execution_id}, headersheaders ) result response.json() print(邮件内容:, result[outputs][email_content])示例2使用API密钥集成到第三方应用import requests BASE_URL http://localhost:8000/api API_KEY your-api-key headers {Authorization: fBearer {API_KEY}} # 使用API密钥获取图列表 response requests.get(f{BASE_URL}/graphs, headersheaders) print(可用的AI代理:, response.json())总结Auto-GPT-ZH提供了全面而强大的API接口支持从简单的AI调用到复杂的工作流自动化。通过本文介绍的API开发者可以快速集成Auto-GPT-ZH的功能到自己的应用中或基于平台进行二次开发创建定制化的AI解决方案。无论是构建智能助手、自动化工作流还是开发复杂的AI应用Auto-GPT-ZH的API都能提供坚实的基础和灵活的扩展能力。建议结合交互式API文档(http://localhost:8000/docs)进行开发以获得最佳体验。Auto-GPT-ZH生态系统展示包括各种集成和扩展可能性【免费下载链接】Auto-GPT-ZHAuto-GPT中文版本及爱好者组织 同步更新原项目 AI领域创业 自媒体组织 用AI工作学习创作变现项目地址: https://gitcode.com/gh_mirrors/au/Auto-GPT-ZH创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考