Update agent configuration
Updated
Updates runtime parameters of a Conversational AI agent instance.
https://api.agora.io/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/updateUse this endpoint to adjust Conversational AI agent instance parameters at runtime.
Path Parameters
The App ID of the project.
The agent instance ID you obtained after successfully calling join to Start a conversational AI agent.
Request Body
application/json
Response
-
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 thedetailandreasonfor failure. Refer to status codes to understand the possible reasons for failure.
Response Body
application/json
application/json
Response schema
200application/jsonThe request was successful. The response body contains the result of the request.
Unique id of the agent instance
Timestamp of when the agent was created
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. -
FAILED(6): The agent failed to execute.
IDLE | STARTING | RUNNING | STOPPING | STOPPED | FAILEDRequest examples
curl --request post \ --url https://api.agora.io/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/update \ --header 'Authorization: Basic <credentials>' \ --data ' { "properties": { "token": "007eJxTYxxxxxxxxxxIaHMLAAAA0ex66", "llm": { "system_messages": [ { "role": "system", "content": "You are a helpful assistant. xxx" }, { "role": "system", "content": "Previously, user has talked about their favorite hobbies with some key topics: xxx" } ], "params": { "model": "abab6.5s-chat", "max_token": 1024 } } } }'Response example
{ "agent_id": "1NT29X10YHxxxxxWJOXLYHNYB", "create_ts": 1737123456, "status": "RUNNING"}{ "detail": "string", "reason": "string"}