Skip to main content
GET
/
v2
/
deployments
/
{deployment_id}
/
init
Get Deployment Init Config
curl --request GET \
  --url https://tavusapi.com/v2/deployments/{deployment_id}/init
{
  "deployment_id": "<string>",
  "customization": {},
  "has_password": true,
  "replica_thumbnail_video_url": "<string>",
  "thumbnail_video_url": "<string>",
  "thumbnail_image_url": "<string>",
  "show_tavus_branding": true,
  "limits": {
    "max_call_duration": 123,
    "daily_call_limit_per_user": 123
  },
  "captcha": {
    "provider": "<string>",
    "site_key": "<string>",
    "challenge_path": "<string>",
    "action": "<string>"
  },
  "is_available": true,
  "unavailable_reason": "<string>"
}
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.

Path Parameters

​
deployment_id
string
required

Response

Init configuration

Configuration returned to widget, embed, and landing-page clients on init.

​
deployment_id
string
​
channel
enum<string>
Available options:
widget,
embed,
landing-page
​
customization
object

Full customization tree including channel-specific blocks (widget, landing_page) and shared screens (preview, haircheck, after_call).

​
has_password
boolean
​
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.

​
show_tavus_branding
boolean
​
limits
object
​
captcha
object

Present when Turnstile is enabled.

​
is_available
boolean
​
unavailable_reason
string

Set when is_available is false, e.g. daily_limit or total_limit.