获取智能体列表

描述

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

接口原型

请求方法：POST
请求体格式：JSON
请求地址：https://aigc-aiagent-api.zegotech.cn?Action=ListAgents
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
Limit	Number	否	单次拉取多少个智能体信息。取值范围为 [0, 10]。如果不填或数值为 0，取值为 5。如果数值小于 0 或大于 10 ，则接口调用报错。
Cursor	String	否	分页拉取标志，第一次不填，之后填上一次返回的 Cursor 值。当返回的 Cursor 为空时，代表智能体列表获取完毕。

请求示例

请求地址 URL：

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=ListAgents
&<公共请求参数>

Copied!

请求消息体：
Untitled
{ "Limit": 10, "Cursor": "" }
1
Copied!

响应参数

参数	类型	描述
Code	Number	返回码。0 表示成功，其他值表示失败。如需了解错误码及响应处理建议，请参考返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Data	Object	返回数据。
└Total	Number	符合查询条件的智能体总数
└Agents	Array of Object	智能体列表。本参数的结构，请参考智能体参数说明 - Agents。
└Cursor	String	非空仅表示还有智能体的信息未返回，需要将该字段设置到请求参数 `Cursor` 中拉取更多智能体的信息；为空表示已经返回所有智能体的信息。

响应示例

Untitled

{
    "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"
    }
}

Copied!