摘要：Coze Studio后端采用了一套全面的API架构，旨在实现灵活性、高性能和开发者易用性。本文档探讨了API的结构、组织及其关键组件，以帮助您有效导航和与系统交互。
Coze Studio后端采用了一套全面的API架构，旨在实现灵活性、高性能和开发者易用性。本文档探讨了API的结构、组织及其关键组件，以帮助您有效导航和与系统交互。
Coze Studio的API基于分层架构，使用Hertz网络框架构建，这是一个适用于Go语言的高性能HTTP框架。API遵循层次组织模式，不同功能域之间有明确的关注点分离。
API围绕核心业务域组织，端点按功能分组，公网API和内部API之间有明确的分隔。、
API基础路径描述版本/api/*核心内部API端点当前/v1/*与OpenAPI兼容的RESTful端点稳定/v3/*最新一代端点最新每个API组包含特定领域的子组，封装了相关功能。这种组织方式使API更易于发现，并保持了关注点的清晰分离。
Coze Studio的主要功能组织成以下API组：
每个组处理系统内的特定功能域：
对话APIs (/api/conversation)：管理聊天交互、消息和对话历史知识APIs (/api/knowledge)：处理知识库、文档和数据检索内存APIs (/api/memory)：管理数据库连接和变量存储插件APIs (/api/plugin_api)：集成和管理外部插件和API工作流APIs (/api/workflow_api)：创建、执行和管理代理工作流Coze Studio的API主要使用两种HTTP方法：
POST：用于大多数操作，包括数据创建、更新和复杂查询GET：用于简单的数据检索操作API端点通常遵循以下命名模式：
API包含几种认证机制：
基于会话的认证，适用于网页界面用户个人访问令牌（PAT），用于API集成OAuth，用于第三方集成这些通过中间件实现，在请求到达处理器之前进行处理：
与认证相关的端点主要位于/api/passport和/api/permission_api组中。
对于公网API访问，Coze Studio在/v1路径下提供OpenAPI兼容端点：
/v1/conversations - 管理对话
/v1/conversation/:id - 操作特定对话
/v1/workflow - 运行和管理工作流
/v1/files - 处理文件上传
这些端点遵循更标准的RESTful约定，专为外部集成设计。
对话APIs处理聊天交互和消息管理：
端点目的/api/conversation/chat启动代理对话/api/conversation/get_message_list检索消息历史/api/conversation/clear_message清除对话历史/api/conversation/delete_message删除特定消息知识库知识APIs管理文档存储和检索：
端点目的/api/knowledge/create创建知识数据集/api/knowledge/document/create向知识库添加文档/api/knowledge/document/list列出可用文档/api/knowledge/slice/list管理文档片段工作流系统工作流APIs支持创建和执行代理工作流：
端点目的/api/workflow_api/create创建新工作流/api/workflow_api/save保存工作流更改/api/workflow_api/test_run测试工作流执行/api/workflow_api/publish发布工作流以供使用/api/workflow_api/node_type查询可用节点类型插件系统插件APIs处理外部工具的集成和管理：
端点目的/api/plugin_api/register注册新插件/api/plugin_api/create_api创建API定义/api/plugin_api/debug_api调试插件API/api/plugin_api/publish_plugin发布插件错误处理API通过一致的响应格式实现标准化错误处理：
错误响应包括：
HTTP状态码内部错误码描述性错误消息可选的上下文数据API实现API端点作为处理器实现在backend/api/handler/coze目录中。每个处理器遵循一致的模式：
请求验证参数提取业务逻辑执行响应格式化处理器与应用层和领域层交互以执行业务逻辑，同时保持关注点分离。
中间件目的会话管理用户会话日志记录API访问和错误上下文缓存优化请求性能认证验证用户身份国际化处理国际化来源：码韵匠道
