Skip to main content

Stop a Real-time STT task

Stop a Real-time STT task

DELETE
https://api.agora.io/v1/projects/{appId}/rtsc/speech-to-text/tasks/{taskId}

Use this endpoint to leave the channel and stop Real-Time STT. To restart transcription, acquire a new one buildToken and call start again.

Request

Path parameters

appId stringrequired

The App ID of the project

taskId stringrequired

The unique identifier of the Real-Time STT task you received in the response body of the start method.

Query parameters

builderToken stringrequired

The tokenName value you obtained in the response body of the acquire 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 delete \
_3
--url 'https://api.agora.io/v1/projects/:appId/rtsc/speech-to-text/tasks/:taskId?builderToken=' \
_3
--header 'Authorization: Basic <credentials>'

vundefined