Sign in

v1

latestOpenAPI 3.0.32026-07-267015229.9 KB
Videos

Generate Video

This endpoint generates a new video using a face and either a script or an audio file.

post/v2/videos

Request body

OR

Example request

{
  "replica_id": "r90bbd427f71",
  "video_name": "My First Video",
  "background_url": "https://yourwebsite.com/",
  "background_source_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/your-background-video.mp4",
  "callback_url": "https://yourwebsite.com/webhook",
  "watermark_image_url": "https://s3.amazonaws.com/watermark.png",
  "properties": {
    "background_scroll": true,
    "start_with_wave": true
  },
  "script": "Hello from Tavus! Enjoy your new face"
}

Response

video_idstring

A unique identifier for the video.

video_namestring

The name of the video.

statusstring

The status of the video. Possible values: queued, generating, ready, deleted, error.

hosted_urlstring

A direct link to view your video once generation has completed, hosted by Tavus.

created_atstring

The date and time the video was created.

Example response

{
  "video_id": "abcd123",
  "video_name": "Sample Video",
  "status": "queued",
  "hosted_url": "https://tavus.video/abcd123",
  "created_at": "Mon, 14 Jul 2025 09:14:24 GMT"
}