Skip to main content
GET
/
v2
/
replicas
/
{replica_id}
Get Replica
curl --request GET \
  --url https://tavusapi.com/v2/replicas/{replica_id} \
  --header 'x-api-key: <api-key>'
{
  "replica_id": "r90bbd427f71",
  "replica_name": "My Replica",
  "thumbnail_video_url": "<string>",
  "training_progress": "100/100",
  "status": "completed",
  "created_at": "2024-01-24T07:14:03.327Z",
  "updated_at": "2024-01-24T07:14:03.327Z",
  "error_message": "<string>",
  "replica_type": "user'",
  "model_name": "phoenix-3"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tavus.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
replica_id
string
required

A unique identifier for the replica.

Query Parameters

​
verbose
boolean

If set to true, the response will include additional replica data such as replica_type.

Response

​
replica_id
string

A unique identifier for the replica.

Example:

"r90bbd427f71"

​
replica_name
string

The name of the replica.

Example:

"My Replica"

​
thumbnail_video_url
string

A direct link to the video that will be used as the thumbnail for the replica.

​
training_progress
string

Training progress as a string (for example 100/100).

Example:

"100/100"

​
status
string

Training lifecycle: started, completed, or error. On failure, this is error and error_message is populated.

Example:

"completed"

​
created_at
string

The date and time the replica was created.

Example:

"2024-01-24T07:14:03.327Z"

​
updated_at
string

The date and time of when the replica was last updated.

Example:

"2024-01-24T07:14:03.327Z"

​
error_message
string | null

When status is error, contains details about the training failure; otherwise typically null.

​
replica_type
string

If verbose query paramter is set to true. The type of replica. Possible values: user, system. User replicas are replicas that have been created by users. System replicas are stock Tavus replicas that anyone may use

Example:

"user'"

​
model_name
string

The Phoenix model the replica was trained on (e.g. phoenix-3, phoenix-4).

Example:

"phoenix-3"