Skip to main content
GET
/
v2
/
replicas
List Replicas
curl --request GET \
  --url https://tavusapi.com/v2/replicas \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "replica_id": "r90bbd427f71",
      "replica_name": "My Replica",
      "thumbnail_video_url": "<string>",
      "training_progress": "100/100",
      "status": "completed",
      "created_at": "<string>",
      "replica_type": "user'",
      "model_name": "phoenix-3"
    }
  ],
  "total_count": 42
}

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

Query Parameters

​
limit
integer

The number of replicas to return per page.

​
page
integer

The page number to return

​
verbose
boolean

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

​
replica_type
enum<string>

If set to user, the response will only include user replicas. If set to system, the response will only include stock replicas.

Available options:
user,
system
​
replica_ids
string

A comma separated list of replica ids to filter the response by. Example: replica_ids=r90bbd427f71

​
model_name
string

Filter the list to replicas trained on a specific Phoenix model (e.g. phoenix-3, phoenix-4).

Response

​
data
object[]

Replicas for the current page; use total_count for the full count under the applied filters.

​
total_count
integer

The total number of replicas given the filters provided.

Example:

42