POST
/
v2
/
videos
curl --request POST \
  --url https://tavusapi.com/v2/videos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "background_url": "",
  "replica_id": "",
  "script": "",
  "video_name": ""
}'
{
  "video_id": "<string>",
  "video_name": "<string>",
  "status": "<string>",
  "hosted_url": "<string>",
  "created_at": "<string>"
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
script
string
required

A text script that will be used to generate the audio in the video.

replica_id
string
required

A unique identifier for the replica that will be used to generate the video.

video_name
string

A name for the video.

background_url
string

A link to a website. This will be used as the background for the video. The website must be publicly accessible and properly formed.

background_source_url
string

A direct link to a video that is publicly accessible via a storage location such as an S3 bucket. This will be used as the background for the video. The video must be publicly accessible.

callback_url
string

A url that will receive a callback on completion of video generation or on error.

Response

200 - application/json
video_id
string

A unique identifier for the video.

video_name
string

The name of the video.

status
string

The status of the video.

hosted_url
string

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

created_at
string

The date and time the video was created.

Rename ReplicaGet Video