Skip to main content

Stop a Real-time STT agent

POST
https://api.agora.io/api/speech-to-text/v1/projects/{appid}/agents/{agentId}/leave

Use this method to leave the channel and stop Real-Time STT.

Request​

Path parameters​

appId stringrequired

The App ID of the project

agentId stringrequired

The unique identifier of the agent you received in the response body of the join method.

Response​

  • If the returned status code is 200, the request was successful.
  • If the returned status code is not 200, the request failed.

Authorization

This endpoint requires Basic Auth.

Request example


_3
curl --request POST \
_3
--url https://api.agora.io/api/speech-to-text/v1/projects/:appid/agents/:agentId/leave \
_3
--header 'Authorization: Basic <credentials>'