Interrupt the agent

Interrupt the agent

POST

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

Use this endpoint to interrupt the specified agent while speaking or thinking.

appid stringrequired

The App ID of the project.

agentId stringrequired

The agent instance ID you obtained after successfully calling join to Start a conversational AI agent.

APPLICATION/JSON

The request body is empty.

• If the returned status code is 200, the request was successful. The response body is empty and the agent stops talking and thinking immediately.

• 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

• curl
• Python
• Node.js

_4

curl --request post \

_4

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

_4

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

_4

--data '{}'