开发指南
除提供 Web 界面外,DolphinX 还开放了丰富的 API 接口,便于开发者将 DolphinX 的能力集成到应用层。本章节介绍 DolphinX API 的基础知识,包括以下内容:
- 通用约定:介绍 DolphinX API 的整体调用规范,为应用层实现提供统一协议、认证、错误、分页和流式处理规则。
- API 列表:介绍 DolphinX API 的请求方法、接口地址、请求参数、请求示例及响应示例,涵盖发现 Agent、创建会话、发起对话、使用技能、读写文件、调用工具、访问网络和调试上下文等接口。
- 响应数据结构:介绍 DolphinX API 响应中反复出现的数据结构,方便开发者根据这些结构处理业务数据。
- 错误码:介绍 DolphinX API 的错误码体系,方便开发者根据错误码在应用层提供更准确的提示或恢复策略。
- WebSocket 协议:介绍如何通过 WebSocket 实现与 HTTP 协议等价的 API 调用能力。
- 技能包规范:介绍 Agent 技能包的格式和加载模型,用于指导开发者编写可被 Agent 使用的技能。
