Skip to main content
GET
/
v2
/
deployments
List Deployments
curl --request GET \
  --url https://tavusapi.com/v2/deployments \
  --header 'x-api-key: <api-key>'
{
  "deployments": [
    {
      "deployment_id": "d1234567890abcdef",
      "pal_id": "pcb7a34da5fe",
      "name": "<string>",
      "has_password": true,
      "customization": {},
      "replica_thumbnail_video_url": "<string>",
      "thumbnail_video_url": "<string>",
      "thumbnail_image_url": "<string>",
      "limits": {},
      "allowed_origins": [
        "<string>"
      ],
      "usage_total": 123,
      "usage_today": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123
}
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.

Authorizations

x-api-key
string
header
required

Query Parameters

pal_id
string

Filter to deployments for a single PAL.

Case-insensitive search on deployment name.

status
string

Comma-separated statuses: draft, active, inactive.

channel
string

Comma-separated channels: widget, embed, landing-page.

limit
integer
default:20
page
integer
default:0
sort
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated deployment list

deployments
object[]
total
integer
page
integer
limit
integer