v1

latestOpenAPI 3.0.32026-07-267015229.9 KB

Deployments

Get Deployment Init Config

Public endpoint called when a widget or embed mounts. Returns customization, limits, captcha settings, and availability.

Does not return a PAL identifier - the widget/embed runtime never reads it from /init.

No API key required. Origin and browser-context checks apply for non-preview callers.

get/v2/deployments/{deployment_id}/init

deployment_idstring required

Init configuration

deployment_idstring

channel'widget' | 'embed' | 'landing-page'

customizationobject

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

has_passwordboolean

replica_thumbnail_video_urlstring nullable

Removed. Use thumbnail_video_url and thumbnail_image_url instead.

thumbnail_video_urlstring nullable

URL for the face preview video thumbnail.

thumbnail_image_urlstring nullable

URL for the face preview image thumbnail.

show_tavus_brandingboolean

is_availableboolean

unavailable_reasonstring

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