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.

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.

APPLICATION/JSON

BODY

• properties objectnullable

  • token stringnullable

    The authentication token used by the agent to join the channel.

• 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 the detail and reason for failure. Refer to status codes to understand the possible reasons for failure.

Authorization

This endpoint requires Basic Auth.

Request example

• curl
• Python
• Node.js

_9

curl --request post \

_9

--url https://api.agora.io/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/update \

_9

--header 'Authorization: Basic <credentials>' \

_9

--data '

_9

{

_9

"properties": {

_9

"token": "007eJxTYxxxxxxxxxxIaHMLAAAA0ex66"

_9

}

_9

}'

Response example

_5

{

_5

"agent_id": "1NT29X10YHxxxxxWJOXLYHNYB",

_5

"create_ts": 1737111452,

_5

"status": "RUNNING"

_5

}