Skip to main content
GET
Get Deployment
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.

Authorizations

x-api-key
string
header
required

Path Parameters

deployment_id
string
required

Deployment UUID.

Response

Deployment details

A managed deployment. See Deployments overview.

deployment_id
string
Example:

"d1234567890abcdef"

pal_id
string

PAL that powers the deployment.

Example:

"pcb7a34da5fe"

channel
enum<string>
Available options:
widget,
embed,
landing-page
status
enum<string>
Available options:
draft,
active,
inactive
name
string
has_password
boolean
customization
object
replica_thumbnail_video_url
string | null
deprecated

Removed. Use thumbnail_video_url and thumbnail_image_url instead.

thumbnail_video_url
string | null

URL for the face preview video thumbnail.

thumbnail_image_url
string | null

URL for the face preview image thumbnail.

limits
object
allowed_origins
string[]
usage_total
integer
usage_today
integer
created_at
string<date-time>
updated_at
string<date-time>