Video Generation
Quickstart
Learn how to quickly generate high-quality videos using your personalized replica.
Prerequisites
Before starting, ensure you have:
- A replica to be used for the video.
- Script:
- Text format.
- Audio:
.mp3
or.wav
format.
Generate a video
1
Step 1: Get an API Key
- Go to the Tavus platform and select API Key from the sidebar menu.
- Click Create New Key to begin generating your API key.
- Enter a name for the key and (optional) specify allowed IP addresses, then click Create API Key.
- Copy your newly created API key and store it securely.
We cannot recover your API Key if you lose it.
2
Step 2: Make a Request
Use the following request to generate a video:
You can also customize the video background to suit your needs. See the Background Customizations article for more details.
3
Step 3: Check Video Generation Status
You can monitor the training status using the Get Video endpoint:
If the video is still being generated, the response will include a status
field set to generating
.
Once the video is fully generated, the response will return a status
field set to ready
.
4
Step 4: Accessing your Video
Once generated, videos can be:
- Streamed or Downloaded: Generated video is hosted on a shareable URL. If a callback is set, a download link is returned when the video generated.
- Embedded or Shared: Use the provided links to distribute your videos across social media, internal tools, or customer platforms.