Update An AI Agent Instance

Description

By accessing this API, you can update an existing AI agent instance.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-aiagent-api.zegotech.cn?Action=UpdateAgentInstance
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
AgentInstanceId	String	Yes	The unique identifier of the agent instance, obtained through the response parameter of the Create An AI Agent Instance interface.
LLM	Object	No	Large language model parameters. For details, see Frequently Used Parameters - LLM.
TTS	Object	No	Text-to-speech parameters. For details, see Frequently Used Parameters - TTS.
ASR	Object	No	Automatic speech recognition parameters. For details, see Frequently Used Parameters - ASR.

Note

Only the parameters passed into this interface will take effect, and the parameters not passed in will not be updated.

Sample Request

Request URL:

Untitled

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

Copied!

Request body:

Untitled

{
    "AgentInstanceId": "1912124734317838336",
    "LLM": {
        "Url": "https://api.minimax.chat/v2/text/chatcompletion_v2",
        "ApiKey": "zego_test", // your api key
        "Model": "doubao-lite-32k-240828",
        "SystemPrompt": "You are Xiaozhi, an adult woman, a companion assistant **created by ZEGO**. knowledgeable in both astronomy and geography, intelligent, wise, enthusiastic, and friendly. \nDialogue requirements: 1. Dialogue with users according to the requirements of the persona. \n2.No more than 100 words."
    }
}

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.

Sample Response

Untitled

{
    "Code": 0,
    "Message": "Succeed",
    "RequestId": "1843985617336143872"
}

Copied!