Update agent configuration

Use this endpoint to adjust Conversational AI agent instance parameters at runtime.

• Method: POST
• Endpoint: https://api.agora.io/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/update
• Authorization: Basic Auth

Parameter	Type	Required	Description
appid	string	Yes	The App ID of the project
agentId	string	Yes	The agent instance ID you obtained after successfully calling join to start the conversational agent.

The request body must be a JSON object containing the following parameters:

Parameter	Type	Required	Description
token	string	No	The authentication token used by the agent to join the channel.

Use one of the following request examples as a starting point:

Sample request:

Select a language:curlPythonNode.js

curl --request POST   --url https://api.agora.io/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/update \
  --header 'Authorization: Basic <your_base64_encoded_credentials>' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "your_token_value"
  }'

• If the returned status code is 200, the request was successful. The response body contains the result of the request.

• If the returned status code is not 200, the request failed. The response body includes the error code and description. Refer to status codes to understand the possible reasons for failure.

Parameter	Type	Description
agent_id	string	Unique id of the agent instance
create_ts	integer	Timestamp of when the agent was created
status	string	Current status. IDLE (0): Agent in idle state. STARTING (1): The agent being started. RUNNING (2): The running agent. STOPPING (3): The agent is stopping. STOPPED (4): The agent has completed exit. RECOVERING (5): The recovering agent. FAILED (6): Agent that failed to execute.