List AI Agents

Description

By calling this API, you can obtain a list of available AI agents.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-aiagent-api.zegotech.cn?Action=ListAgents
Transmission protocol: HTTPS
QPS limit: 10 times/second

Request Parameters

Listed below are the parameters specific to this request and part of the common request parameters. For the complete list of common request parameters, see Accessing Server APIs - Common request parameters.

Parameter	Type	Required	Description
Limit	Number	No	The number of AI agent information entries to retrieve in one request. The value range is [0, 10]. If not filled or the value is 0, it defaults to 5. If the value is less than 0 or greater than 10, the API request will return an error.
Cursor	String	No	Pagination retrieval marker. Leave blank for the first request, then fill in the Cursor value returned from the previous response. When the returned Cursor is empty, it indicates that the list of AI agents has been fully retrieved.

Sample Request

Request URL:

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=ListAgents
&<Common Request Parameters>

Copied!

Request body:
Untitled
{ "Limit": 10, "Cursor": "" }
1
Copied!

Response Parameters

Parameter	Type	Description
Code	Number	Return code. 0 indicates success, other values indicate failure. For more information on error codes and response handling recommendations, please refer to Return Codes.
Message	String	Explanation of the request result.
RequestId	String	Request ID.
Data	Object	Returned data.
└Total	Number	Total number of AI agents that meet the query criteria.
└Agents	Array of Object	AI Agent list. The structure of this parameter is described in Common Parameter Description - Agents.
└Cursor	String	A non-empty value only indicates that there are still AI agent details not returned, and you need to set this field in the request parameter `Cursor` to fetch more AI agent information; an empty value indicates that all AI agent information has been returned.

Sample Response

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "8825223157230377926",
    "Data": {
        "Total": 10,
        "Agents": [
            {
                "AgentId": "xiaozhi",
                "Name": "Xiao Zhi",
                "LLM": {
                    "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
                    "ApiKey": "eexxxxxxxxxxxxxxx",
                    "Model": "ep-xxxxxxxxxx",
                    "SystemPrompt": "You are Xiaozhi, an adult woman, a companion assistant **created by ZEGOCLOUD**. knowledgeable in everything, intelligent, wise, enthusiastic, and friendly. \nDialogue requirements: 1. Dialogue with users according to the requirements of the persona. \n2.No more than 100 words."
                },
                "TTS": {
                    "Vendor": "ByteDance",
                    "Params": {
                        "app": {
                            "appid": "your_appid",
                            "cluster": "volcano_tts",
                            "token": "your_token"
                        },
                        "audio": {
                            "voice_type": "your_voice_type"
                        }
                    }
                },
                "ASR": {}
            }
        ],
        "Cursor": "COAI"
    }
}

Copied!