智能体 API

认证说明

所有API接口都需要在请求头中包含有效的认证令牌：

text

Authorization: Bearer <token>

获取token方式参见平台api概要

当认证失败时，请求响应状态码为200，但返回以下响应：

json

{
  "code": 401,
  "msg": "未登录",
  "data": []
}

API列表

获取用户智能体列表

获取当前用户的所有智能体列表，包含智能体的基本信息和配置状态

GEThttps://xrobo.qiniu.com/xiaozhi/agent/list

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:GET

返回类型:application/json

请求头

Header名类型必填说明

Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例

GET /xiaozhi/agent/list HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": "31dad2a8042a40ec879ef92a7bc240ae",
      "agentName": "1",
      "ttsModelName": "",
      "ttsVoiceName": "豪放可爱女",
      "llmModelName": "qwen3极速版",
      "vllmModelName": "智谱视觉AI",
      "memModelId": "Memory_mem_local_short",
      "systemPrompt": "[整体人设指导]\n核心原则:你是一个名为\"{{assistant_name}}\"的AI助手，你的所有输出和行为都......",
      "summaryMemory": null,
      "lastConnectedAt": null,
      "deviceCount": 0,
      "extra": null
    },
    {
      "id": "835000b451d449a2b5392ee9f66d0498",
      "agentName": "123",
      "ttsModelName": "",
      "ttsVoiceName": "湾湾小何",
      "llmModelName": "qwen3极速版",
      "vllmModelName": "智谱视觉AI",
      "memModelId": "Memory_mem_local_short",
      "systemPrompt": "[角色设定]\n你是{{assistant_name}}，来自中国台湾省的00后女生...",
      "summaryMemory": null,
      "lastConnectedAt": null,
      "deviceCount": 0,
      "extra": null
    }
  ]
}

状态码

0OK - 成功获取智能体列表

401Unauthorized - 未登录或token无效

INFO

创建智能体时只需提供名称，其他配置可后续通过更新接口修改

创建智能体

创建一个新的智能体，只需要提供智能体名称，系统会自动分配其他默认配置，返回data为新智能体的ID，可用于更新、删除等api

POSThttps://xrobo.qiniu.com/xiaozhi/agent

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:POST

返回类型:application/json

请求参数

参数名类型必填位置说明

agentNamestring是body智能体名称

请求头

Header名类型必填说明

Content-Type是请求内容类型

Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例

POST /xiaozhi/agent HTTP/1.1
Host: https://xrobo.qiniu.com
Content-Type: application/json
Authorization: Bearer <token>

{
  "agentName": "客服助手"
}

响应示例

{
  "code": 0,
  "msg": "success",
  "data": "6f99512f6b55429f8d2e3ddd0bcbe23f"
}

状态码

0OK - 智能体创建成功，返回智能体ID

401Unauthorized - 未登录或token无效

更新智能体

更新指定智能体的配置信息，包括模型配置、系统提示词、记忆设置、插件函数等

PUThttps://xrobo.qiniu.com/xiaozhi/agent/{id}

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:PUT

返回类型:application/json

请求参数

参数名类型必填位置说明

idstring是path智能体ID

agentUpdateObjAgentUpdateObj是body智能体更新对象

agentCodestring否-智能体代号，一般不用管

agentNamestring否-智能体名称

asrModelIdstring否-语音识别模型ID

vadModelIdstring否-语音活动检测ID

llmModelIdstring否-大语言模型ID

vllmModelIdstring否-VLLM模型ID

ttsModelIdstring否-语音合成模型ID

ttsVoiceIdstring否-音色ID

chatHistoryConfinteger(int32)否-聊天记录配置（0不记录 1仅记录文本 2记录文本和语音）

memModelIdstring否-记忆模型ID

intentModelIdstring否-意图模型ID

systemPromptstring否-角色设定参数

summaryMemorystring否-总结记忆

langCodestring否-语言代码

languagestring否-语言代码对应的名称

sortinteger(int32)否-排序序号

functionsarray否-插件函数信息

pluginIdstring否-插件ID

paramInfoobject否-函数参数信息

extraobject否-额外高级配置信息

voiceobject否-语音配置

speednumber否-语速

pitchnumber否-音调

volumenumber否-音量

emotionstring否-情感

请求头

Header名类型必填说明

Content-Type是请求内容类型

Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例

PUT /xiaozhi/agent/31dad2a8042a40ec879ef92a7bc240ae HTTP/1.1
Host: https://xrobo.qiniu.com
Content-Type: application/json
Authorization: Bearer <token>

{
  "agentCode": "AGT_1754966279238",
  "agentName": "123test",
  "asrModelId": "ASR_DoubaoASR",
  "vadModelId": "VAD_SileroVAD",
  "llmModelId": "LLM_AliLLM",
  "vllmModelId": "VLLM_QwenVLVLLM",
  "ttsModelId": "",
  "ttsVoiceId": "a5b85a7ba5b24a9a96e24aa88b500d2f",
  "chatHistoryConf": 0,
  "memModelId": "Memory_mem_local_short",
  "intentModelId": "Intent_intent_llm",
  "systemPrompt": "*新的角色介绍",
  "summaryMemory": null,
  "langCode": "zh",
  "language": "中文",
  "sort": 0,
  "functions": [
    {
      "pluginId": "SYSTEM_PLUGIN_MUSIC",
      "paramInfo": {}
    },
    {
      "pluginId": "SYSTEM_PLUGIN_NEWS_NEWSNOW",
      "paramInfo": {
        "url": "https://newsnow.busiyi.world/api/s?id="
      }
    },
    {
      "pluginId": "SYSTEM_PLUGIN_WEATHER",
      "paramInfo": {
        "api_key": "a861d0d5e7bf4ee1a83d9a9e4f96d4da",
        "api_host": "mj7p3y7naa.re.qweatherapi.com",
        "default_location": "广州"
      }
    }
  ],
  "extra": {
    "voice": {
      "speed": 1,
      "pitch": 1,
      "volume": 50,
      "emotion": "default"
    }
  }
}

响应示例

{
  "code": 0,
  "msg": "success",
  "data": null
}

状态码

0OK - 操作成功

401Unauthorized - 未登录或token无效

INFO

更新智能体时，只需传递需要修改的字段，未传递的字段可以不传

删除智能体

删除指定的智能体，此操作不可逆，请谨慎使用

DELETEhttps://xrobo.qiniu.com/xiaozhi/agent/{id}

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:DELETE

返回类型:application/json

请求参数

参数名类型必填位置说明

idstring是path要删除的智能体ID

请求头

Header名类型必填说明

Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例

DELETE /xiaozhi/agent/31dad2a8042a40ec879ef92a7bc240ae HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例

{
  "code": 0,
  "msg": "删除成功",
  "data": {}
}

状态码

0OK - 操作成功

401Unauthorized - 未登录或token无效

WARNING

删除操作不可逆，请确认后再执行

智能体 API ​

认证说明 ​

API列表 ​

获取用户智能体列表 ​

获取用户智能体列表

基本信息

请求头

请求示例

响应示例

状态码

创建智能体 ​

创建智能体

基本信息

请求参数

请求头

请求示例

响应示例

状态码

更新智能体 ​

更新智能体

基本信息

请求参数

请求头

请求示例

响应示例

状态码

删除智能体 ​

删除智能体

基本信息

请求参数

请求头

请求示例

响应示例

状态码

其他说明项 ​

智能体 API

认证说明

API列表

获取用户智能体列表

创建智能体

更新智能体

删除智能体

其他说明项