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": "",
  "replica_name": "",
  "train_video_url": ""
}'
{
  "replica_id": "r783537ef5",
  "status": "training"
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
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.

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.

callback_url
string

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

replica_name
string

A name for the replica.

model_name
string

The phoenix model version that will be used to train the replica.

Response

200 - application/json
replica_id
string

A unique identifier for the replica.

status
string

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