Skip to main content
POST
/
v2
/
replicas
curl --request POST \
  --url https://tavusapi.com/v2/replicas \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "callback_url": "https://yourwebsite.com/webhook",
  "replica_name": "Rio",
  "train_video_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/your-train-video.mp4",
  "consent_video_url": "https://my-example-bucket.s3.us-east-1.amazonaws.com/your-consent-video.mp4"
}'
{
  "replica_id": "r783537ef5",
  "status": "started"
}
By default, all new replicas are trained using the phoenix-3 model.
To use the older phoenix-2 model, set the model_name parameter to phoenix-2.
Required parameters vary based on the replica type:Personal Replica:
  • train_video_url
  • consent_video_url
Non-Human Replica:
  • train_video_url
Make sure the train_video_url and consent_video_url are publicly accessible download links, such as presigned S3 URLs.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
train_video_url
string
required

A direct link to a publicly accessible storage location such as an S3 bucket. This video will be used for replica training.

Example:

"https://my-example-bucket.s3.us-east-1.amazonaws.com/your-train-video.mp4"

​
consent_video_url
string

A direct link to a video that contains the consent statement. You may optionally send the consent statement in a separate video from your training video. If you do not provide a consent video, the consent statement must be present at the beginning of the training video. This value is required if you want to create a personal replica.

Example:

"https://my-example-bucket.s3.us-east-1.amazonaws.com/your-consent-video.mp4"

​
callback_url
string

A url that will receive a callback on completion of replica training or on error.

Example:

"https://yourwebsite.com/webhook"

​
replica_name
string

A name for the replica.

Example:

"Rio"

​
model_name
string

The phoenix model version that will be used to train the replica. The current default is phoenix-3.

Example:

"phoenix-3"

​
properties
object

Response

​
replica_id
string

A unique identifier for the replica.

Example:

"r783537ef5"

​
status
string

The status of the replica. Possible values: started, completed, error.

Example:

"started"

⌘I