ListAgents

POST

https://aigc-aiagent-api.zegotech.cn/

通过向本接口，您可以获取可用的智能体列表。

Request

Query Parameters

Action stringrequired

Possible values: [ListAgents]

接口原型参数

https://aigc-aiagent-api.zegotech.cn?Action=ListAgents

AppId uint32required

AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

随机字符串。

Timestamp int64required

Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

签名版本号，默认值为 2.0。

application/json

Body

required

Limit integer

Possible values: >= 0 and <= 10

Default value: 5

单次拉取多少个智能体信息。如果数值小于 0 或大于 10 ，则接口调用报错。

Cursor string

分页拉取标志，第一次不填，之后填上一次返回的 Cursor 值。当返回的 Cursor 为空时，代表智能体列表获取完毕。

Responses

获取成功

application/json

Schema
Example (from schema)
Example

Schema

Code integer

返回码，0 表示成功，其他值表示失败。详情请参考返回码说明。

Message string

请求结果说明

RequestId string

请求 ID

Data object

Total integer

符合查询条件的智能体总数

Agents object[]

智能体列表

Array[

AgentId string

智能体唯一标识符

Name string

智能体名称

LLM object

Url stringrequired

接收请求的端点（可以是你自己的服务，也可以是任何 LLM 服务提供商提供的服务），并且必须兼容 OpenAI Chat Completions API。

例如：https://api.openai.com/v1/chat/completions

📌 重要说明

如果 ApiKey 设置为 "zego_test"，则必须使用以下 Url 地址之一：

MiniMax：https://api.minimax.chat/v1/text/chatcompletion_v2

火山引擎（豆包）：https://ark.cn-beijing.volces.com/api/v3/chat/completions

阿里云百炼（通义千问）：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions

阶跃星辰：https://api.stepfun.com/v1/chat/completions

ApiKey string

LLM 服务提供商用于认证的参数。默认为空，但在生产环境中必须提供。

📌 重要说明

在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。

Model stringrequired

LLM 模型。不同的 LLM 服务提供商支持不同的模型，请参考其官方文档选择合适的模型。

📌 重要说明

如果 ApiKey 设置为 "zego_test"，则必须使用以下模型之一：

MiniMax：

MiniMax-Text-01

火山引擎（豆包）：

doubao-1-5-pro-32k-250115

doubao-1-5-lite-32k-250115

阿里云百炼（通义千问）：

qwen-plus

阶跃星辰：

step-2-16k

SystemPrompt string

智能体系统提示（prompt）。调用 LLM 时附加在最前的预定义信息，用于控制 LLM 输出。可以是角色设定、提示词和回答样例等。

Temperature number

Possible values: >= 0 and <= 2

Default value: 0.7

数值越高，输出越随机；数值越低，输出越集中和确定。

TopP number

Possible values: >= 0 and <= 1

Default value: 0.9

采样方法，数值越小，确定性越强；数值越大，随机性越强。

Params object

LLM 服务提供商支持的其他参数，如最大 Token 数量限制等。不同的 LLM 提供商支持不同的参数，请参考其官方文档并根据需要填写。

AddAgentInfo boolean

Default value: false

如果此值为 true，AI Agent 服务器在请求 LLM 服务时会在请求参数中包含智能体信息。您可以使用此参数在自定义 LLM 服务中执行额外的业务逻辑。

agent_info 的结构如下：

room_id: 房间 ID
user_id: 用户 ID
agent_instance_id: 智能体实例 ID

TTS object

Vendor stringrequired

Possible values: [Aliyun, ByteDance, ByteDanceFlowing, MiniMax, CosyVoice]

语音合成（TTS）服务提供商。详细请参考配置 TTS > TTS 参数说明

Params objectrequired

TTS 配置参数，格式为 JSON 对象。包含 app 参数（用于认证）和其他参数（用于调整 TTS 效果）。详细请参考配置 TTS > Params 参数说明

app objectrequired

用于 TTS 服务鉴权，不同的 Vendor 值要求传入的 app 参数的结构不同，详细请参考配置 TTS > Params 参数说明

other_params string

📌 重要说明

other_params 不是一个有效参数，仅仅是为了说明如何透传厂商参数。除 app 参数外，其余参数均直接透传厂商参数。详细请参考配置 TTS > Params 参数说明

FilterText object[]

从 LLM 返回的内容中过滤指定标点符号内的文本，然后再进行语音合成。注意：- 需要在 LLM > SystemPrompt 中定义哪些内容应该放在指定标点符号内- 此参数在更新智能体实例时无法更新

Array[

BeginCharacters stringrequired

过滤文本的开始标点符号。例如，如果要过滤 () 中的内容，请设置为 (。

EndCharacters stringrequired

过滤文本的结束标点符号。例如，如果要过滤 () 中的内容，请设置为 )。

]

TerminatorText string

Possible values: <= 4 characters

可用于设置 TTS 的终止文本。若输入 TTS 的文本中出现匹配 TerminatorText 字符串的内容，则本轮 TTS 从 TerminatorText 字符串（包含）开始的内容将不再进行语音合成。

📌 重要说明

双向流式只能设置一个字符。

ASR object

Vendor string

Possible values: [Tencent, AliyunParaformer, AliyunGummy, Microsoft]

Default value: Tencent

ASR 厂商。可参考配置 ASR 参数说明。

Params object

厂商参数，具体使用方式参考配置 ASR 中的 Params 参数说明。

VADSilenceSegmentation number

Possible values: >= 200 and <= 2000

Default value: 500

用于设置用户说话停顿多少秒后，不再将两句话视为一句。单位为 ms，范围 [200，2000]，默认为 500。详细说明请参考语音识别断句。

PauseInterval number

Possible values: >= 200 and <= 2000

用于设置用户说话停顿多少秒内，将两句话视为一句，即 ASR 多句拼接。单位为 ms，范围 [200，2000]。仅当此值大于 VADSilenceSegmentation 时，才会启用 ASR 多句拼接。详细说明请参考语音识别断句。

HotWord stringdeprecated

该参数已废弃。请通过 Params 厂商参数设置。

]

Cursor string

非空仅表示还有智能体的信息未返回，需要将该字段设置到请求参数 Cursor 中拉取更多智能体的信息；为空表示已经返回所有智能体的信息。

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "Agents": [
      {
        "AgentId": "xiaozhi",
        "Name": "小智",
        "LLM": {
          "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
          "ApiKey": "zego_test",
          "Model": "doubao-1-5-lite-32k-250115",
          "SystemPrompt": "你是一个友好的助手",
          "Temperature": 0.7,
          "TopP": 0.9,
          "Params": {
            "max_tokens": 16384
          },
          "AddAgentInfo": false
        },
        "TTS": {
          "Vendor": "ByteDance",
          "Params": {
            "app": {
              "appid": "zego_test",
              "token": "zego_test",
              "cluster": "volcano_tts"
            },
            "audio": {
              "voice_type": "zh_female_qingxinnvsheng_mars_bigtts",
              "loudness_ratio": 1,
              "speed_ratio": 1
            }
          },
          "FilterText": [
            {
              "BeginCharacters": "(",
              "EndCharacters": ")"
            }
          ],
          "TerminatorText": "string"
        },
        "ASR": {
          "Vendor": "Tencent",
          "Params": {
            "engine_model_type": "16k_en",
            "hotword_list": "zego|10"
          },
          "VADSilenceSegmentation": 500,
          "PauseInterval": 800
        }
      }
    ],
    "Cursor": "COAI"
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "Agents": [
      {
        "AgentId": "xiaozhi",
        "Name": "小智",
        "LLM": {
          "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
          "ApiKey": "zego_test",
          "Model": "doubao-1-5-lite-32k-250115",
          "SystemPrompt": "你是一个友好的助手",
          "Temperature": 0.7,
          "TopP": 0.9,
          "Params": {
            "max_tokens": 16384
          },
          "AddAgentInfo": false
        },
        "TTS": {
          "Vendor": "ByteDance",
          "Params": {
            "app": {
              "appid": "zego_test",
              "token": "zego_test",
              "cluster": "volcano_tts"
            },
            "audio": {
              "voice_type": "zh_female_qingxinnvsheng_mars_bigtts",
              "loudness_ratio": 1,
              "speed_ratio": 1
            }
          },
          "FilterText": [
            {
              "BeginCharacters": "(",
              "EndCharacters": ")"
            }
          ],
          "TerminatorText": "string"
        },
        "ASR": {
          "Vendor": "Tencent",
          "Params": {
            "engine_model_type": "16k_en",
            "hotword_list": "zego|10"
          },
          "VADSilenceSegmentation": 500,
          "PauseInterval": 800
        }
      }
    ],
    "Cursor": "COAI"
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "Agents": [
      {
        "AgentId": "xiaozhi",
        "Name": "小智",
        "LLM": {
          "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
          "ApiKey": "eexxxxxxxxxxxxxxx",
          "Model": "ep-xxxxxxxxxx",
          "SystemPrompt": "你是小智，成年女性，是**即构科技创造的陪伴助手**，上知天文下知地理，聪明睿智、热情友善。\n对话要求：1、按照人设要求与用户对话。\n2、不能超过100字。"
        },
        "TTS": {
          "Vendor": "ByteDance",
          "Params": {
            "app": {
              "appid": "your_appid",
              "cluster": "volcano_tts",
              "token": "your_token"
            },
            "audio": {
              "voice_type": "your_voice_type"
            }
          }
        },
        "ASR": {}
      }
    ],
    "Cursor": "COAI"
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "Agents": [
      {
        "AgentId": "xiaozhi",
        "Name": "小智",
        "LLM": {
          "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
          "ApiKey": "eexxxxxxxxxxxxxxx",
          "Model": "ep-xxxxxxxxxx",
          "SystemPrompt": "你是小智，成年女性，是**即构科技创造的陪伴助手**，上知天文下知地理，聪明睿智、热情友善。\n对话要求：1、按照人设要求与用户对话。\n2、不能超过100字。"
        },
        "TTS": {
          "Vendor": "ByteDance",
          "Params": {
            "app": {
              "appid": "your_appid",
              "cluster": "volcano_tts",
              "token": "your_token"
            },
            "audio": {
              "voice_type": "your_voice_type"
            }
          }
        },
        "ASR": {}
      }
    ],
    "Cursor": "COAI"
  }
}

CURL

RESPONSEClear

Click the "Send" button above and see the response here!