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

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=re1074c227,r243eed46c

Response

200
application/json

The response is of type object.