基于 APIs 开发

ChatDZQ 基于“后端即服务”理念为所有智能体提供了 API，为 AI 应用开发者带来了诸多便利。通过这一理念，开发者可以直接在前端应用中获取大型语言模型的强大能力，而无需关注复杂的后端架构和部署过程。

使用 ChatDZQ API 的好处

• 让前端应用直接安全地调用 LLM 能力，省去后端服务的开发过程

• 在可视化的界面中设计应用，并在所有客户端中实时生效

• 对 LLM 供应商的基础能力进行了良好封装

• 随时切换 LLM 供应商，无需在各个供应商处开通账号，统一管理费用消耗。

如何使用

选择一个智能体，在智能体-编排页面顶部导航中切换到发布-API接口。在该页面中你可以查看 ChatDZQ 提供的 API 文档，并管理可访问该智能体 API 的智能体标识（sk）。

• 点击查看接口文档，详细API接入文档。

通过sk秘钥建立聊天通道、并且回答用户信息实现方式。 通过智能体标识（sk秘钥）、进行该智能体的AI对话能力功能。

发起智能体对话

基础信息

接口地址: /portal/ai/chat

请求方法: POST

接口描述: 该接口用于发起智能体对话

请求头（Headers）

参数名	参数值	描述
Content-Type	application/json	请求体格式为JSON
Accept	/	接受所有类型的响应
Connection	keep-alive	保持连接

请求体（Body）

请求体为JSON格式，具体参数如下：

名称	类型	必选	说明
stream	boolean	是	是否流式返回 暂时支持ture
content	string	是	用户输入/提问内容。
sk	string	是	智能体标识
groupId	string	是	聊天组编码（每回对话记录编码）
source	string	是	来源

请求示例

{
  "stream": true,
  "content": "string",
  "sk": "{{YOUR_agent_sk}}",
  "groupId": "string",
  "source": "string"
}

响应示例

{
  "data": {
    "code": "1851182131407831042",
    "type": "CHAT",
    "content": "这是回复的信息内容"
  },
  "success": true,
  "code": 200,
  "message": "成功",
  "innerMessage": "",
  "systemCurrentTime": 1730191188206
}

阻塞模式

{
  "data": {},
  "success": false,
  "code": 502,
  "message": "失败",
  "innerMessage": "入参错误",
  "systemCurrentTime": 1730191188206
}

{
  "success": false,
  "code": -1,
  "message": "系统异常,稍后再来试试看",
  "innerMessage": "",
  "systemCurrentTime": 1730192448093
}

响应参数说明

名称	类型	必选	约束	中文名	说明
data	object	true	none	结果对象	none
» code	string	true	none	当前聊天记录code	none
» type	string	true	none	聊天类型	none
» content	string	true	none	回复内容	none
success	boolean	true	none	是否成功	none
code	integer	true	none	响应码，200表示成功	none
message	string	true	none	接口结果信息	none
innerMessage	string	true	none	接口错误信息	none
systemCurrentTime	integer	true	none	当前时间	none

图片识别接口

接口概述

接口名称: 图片识别与分析

接口地址: https://www.chatdzq.com/portal/ai/chat

请求方法: POST

接口描述: 该接口用于分析图片信息。

请求头（Headers）

参数名	参数值	描述
Content-Type	application/json	请求体格式为JSON
Accept	/	接受所有类型的响应
Connection	keep-alive	保持连接

请求体（Body）

请求体为JSON格式，具体参数如下：

参数名	类型	是否必填	描述
groupId	string	是	群组ID，用于标识请求所属的群组
content	string	是	请求内容，描述需要分析的任务，例如“分析图片中的人是谁，在干什么”
source	string	是	域名，例如xxx.xxx.com
fileUrlList	array	是	图片的URL列表，支持多个图片URL
type	string	是	请求类型，固定值SYSTEM_IMAGE_RECOGNITION_CHAT
tntInstId	string	是	租户实例ID，用于标识请求所属的租户

请求示例

curl --location --request POST 'https://www.chatdzq.com/portal/ai/chat' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '{
    "groupId": "18914038xxxx",
    "content": "分析图片中的人是谁，在干什么",
    "source": "www.chatdzq.com",
    "fileUrlList":["https://xxxx.com/xxx.png"],
    "type":"SYSTEM_IMAGE_RECOGNITION_CHAT",
    "tntInstId":"172571024261xxxx"
}'

注意事项 请求体中的fileUrlList必须为有效的图片URL。 type字段必须为SYSTEM_IMAGE_RECOGNITION_CHAT，否则请求会被拒绝。

响应示例

{
  "requestId": null,
  "success": true,
  "code": 200,
  "message": "成功",
  "innerMessage": "",
  "systemCurrentTime": 1739843924177,
  "data": {
    "id": null,
    "code": "1891668630033084417",
    "content": "图",
    "requestToken": "",
    "promptToken": "",
    "contentToken": "",
    "type": "CHAT",
    "quoteNum": 0,
    "extend": "{}",
    "model": "",
    "robotCode": null,
    "log": null,
    "name": null,
    "errorCode": null,
    "requestCount": null,
    "robotType": null,
    "intentionalAnalysisName": null,
    "intentionalAnalysisLog": null,
    "intentionalAnalysisLabel": null,
    "intentionalAnalysisFlag": null,
    "intentionalAnalysisLabelCode": null,
    "intentionalAnalysisType": null,
    "intentionalAnalysisCode": null,
    "resourceCode": null,
    "wordartResourceCode": null,
    "wordartResourceUrl": null,
    "text": null,
    "documentRecordCode": null,
    "llmCode": null
  }
}

响应参数说明

名称	类型	必选	约束	中文名	说明
data	object	true	none	结果对象	none
» code	string	true	none	当前聊天记录code	none
» type	string	true	none	聊天类型	none
» content	string	true	none	回复内容	none
success	boolean	true	none	是否成功	none
code	integer	true	none	响应码，200表示成功	none
message	string	true	none	接口结果信息	none
innerMessage	string	true	none	接口错误信息	none
systemCurrentTime	integer	true	none	当前时间	none