Video Request
List Videos
Video Request
List Videos
This endpoint returns a list of all videos that have been generated by the API Key in use.
GET
/
v2
/
videos
x-api-key
string
*
x-api-key
Required
string
curl --request GET \
--url https://tavusapi.com/v2/videos \
--header 'x-api-key: <api-key>'
{
"data": [
{
"replica_id": "r783537ef5",
"script": "Hello from Tavus! Enjoy your new replica",
"video_name": "My First Video",
"background_url": "<string>",
"background_source_url": "<string>"
}
]
}
Authorizations
x-api-key
string
headerrequiredResponse
200 - application/json
data
object[]
data.replica_id
string
A unique identifier for the replica that will be used to generate the video.
data.script
string
A script to be used for the video.
data.video_name
string
A name for the video.
data.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.
data.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.
curl --request GET \
--url https://tavusapi.com/v2/videos \
--header 'x-api-key: <api-key>'
{
"data": [
{
"replica_id": "r783537ef5",
"script": "Hello from Tavus! Enjoy your new replica",
"video_name": "My First Video",
"background_url": "<string>",
"background_source_url": "<string>"
}
]
}