Transcriptions

Create Transcription

Changed on

This endpoint creates a transcription request that will convert speech to text in your video content.

post/v2/transcriptions

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/transcriptions
  • Auth
    API key in header x-api-key

Request body

file_urlstring required

A direct link to the video that will be transcribed. This should be a publicly accessible / presigned S3 URL.

callback_urlstring required

A url that will receive a callback on completion of the transcription or on error.

Example request

{
  "file_url": "https://example.com/video.mp4",
  "callback_url": "https://your-callback-url.com"
}

Response

transcription_idstring

A unique identifier for the transcription.

statusstring

The status of the transcription.

callback_urlstring

The callback URL provided in the request.

Example response

{
  "transcription_id": "t0108f2d24k2a",
  "callback_url": "https://your-callback-url.com"
}

Changes