概述与认证方式
更新时间:2026-10-23
概述
DataAgent OpenAPI 提供工作空间内 Data Agent 的会话初始化、配置与对话能力,并提供本体、Logic、DataSearch 和 Skill 等可选资源的查询能力。对话支持流式(SSE)和非流式两种交互方式。
- 协议:HTTPS
- 数据格式:JSON(流式接口为
text/event-stream) - 字符编码:UTF-8
认证方式
使用百度云 AK/SK 鉴权,在请求 Header 中携带 Authorization 字段。
鉴权方式参考:百度云鉴权认证机制
| Header 参数 | 是否必填 | 说明 |
|---|---|---|
Authorization |
是 | AK/SK 生成的签名串 |
Content-Type |
按需 | POST、PUT 请求固定为 application/json;GET 请求无需设置 |
X-App-Id |
是 | 固定值 dataagent-service |
接口列表
| 接口名称 | 请求方式 | 路径 |
|---|---|---|
| 创建 Agent | POST | /v2/workspaces/{workspaceId}/dataagent/agents/create |
| 更新 Agent | PUT | /v2/workspaces/{workspaceId}/dataagent/agents/{agentId} |
| 流式对话(SSE) | POST | /v2/workspaces/{workspaceId}/dataagent/agents/{agentId}/stream |
| 非流式对话 | POST | /v2/workspaces/{workspaceId}/dataagent/agents/{agentId}/query |
| 查询已发布本体对象类型 | GET | /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published |
| 查询 Logic/DataSearch 列表 | GET | /v2/workspaces/{workspaceId}/logic |
| 查询可执行 Skill 列表 | GET | /v2/workspaces/{workspaceId}/agent/skills |
错误响应格式
所有非 2xx 响应均返回统一错误结构:
JSON
1{
2 "requestId": "trace_id_string",
3 "code": "DataAgentResourceNotBound",
4 "message": "默认资源组未绑定 DataAgent 资源(DATAAGENT_CLUSTER),请先在工作空间绑定资源后再发起请求",
5 "result": null
6}
| 字段 | 类型 | 说明 |
|---|---|---|
requestId |
string | 请求追踪 ID(对应服务端 traceId) |
code |
string | 业务错误码 |
message |
string | 错误描述,面向用户展示 |
result |
null | 出错时固定为 null |
评价此篇文章
