TAtavus
Videos

Get Video

This endpoint returns a single video by its unique identifier.

get/v2/videos/{video_id}

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/videos/{video_id}
  • Auth
    API key in header x-api-key

Path parameters

video_idstring required

A unique identifier for the video.

Query parameters

verboseboolean

If set to true, the response will include additional video data such as the thumbnail image and gif links.

Response

OK

video_idstring

A unique identifier for the video.

video_namestring

The name of the video.

statusstring

Lifecycle status; possible values: queued, generating, ready, deleted, error. When ready, download_url, stream_url, and hosted_url are populated for download, stream, and viewing respectively.

download_urlstring

A direct link to download your generated video (populated when status is ready).

stream_urlstring

A direct link to stream your generated video (populated when status is ready).

hosted_urlstring

A direct link to view your generated video, hosted by Tavus (populated when status is ready).

status_detailsstring

A detailed status of the video.

created_atstring

The date and time the video was created.

updated_atstring

The date and time of when the video was last updated.

still_image_thumbnail_urlstring

Included if the verbose query parameter is set to true. A link to an image thumbnail of the video.

gif_thumbnail_urlstring

Included if the verbose query parameter is set to true. A link to a gif thumbnail of the video.

Example response

{
  "status": "ready"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.