Skip to main content

Stop a conversational AI agent

Stop a conversational AI agent

POST
https://api.agora.io/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/leave

Use this endpoint to stop the specified Conversational AI agent instance.

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.

Response

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

  • 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.

Authorization

This endpoint requires Basic Auth.

Request example


_3
curl --request post \
_3
--url https://api.agora.io/api/conversational-ai-agent/v2/projects/:appid/agents/:agentid/leave \
_3
--header 'Authorization: Basic <your_base64_encoded_credentials>'

vundefined