Update agent configuration
Update agent configuration
POST
https://api.agora.io/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/update
Use this endpoint to adjust Conversational AI agent instance parameters at runtime.
Request
Path parameters
appid stringrequired
The App ID of the project
agentId stringrequired
The agent instance ID you obtained after successfully calling join
to start the conversational agent.
Request body
APPLICATION/JSON
BODY
- properties objectnullable
- token stringnullable
The authentication token used by the agent to join the channel.
Response
-
If the returned status code is
200
, the request was successful. The response body contains the result of the request.OK
- agent_id string
Unique id of the agent instance
- create_ts integer
Timestamp of when the agent was created
- status string
Possible values:
IDLE
,STARTING
,RUNNING
,STOPPING
,STOPPED
,RECOVERING
,FAILED
Current status.
IDLE
(0): Agent is idle.STARTING
(1): The agent is being started.RUNNING
(2): The agent is running.STOPPING
(3): The agent is stopping.STOPPED
(4): The agent has exited.RECOVERING
(5): The agent is recovering.FAILED
(6): The agent failed to execute.
-
If the returned status code is not
200
, the request failed. The response body includes thedetail
andreason
for failure. Refer to status codes to understand the possible reasons for failure.