TAtavus
Deployments

Create Deployment

Changed on

Create a managed deployment for the widget, embed, or landing-page channel.

See Deployments overview.

post/v2/deployments

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/deployments
  • Auth
    API key in header x-api-key

Request body

pal_idstring required

PAL that powers the deployment.

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

Delivery channel. See Deployments overview.

namestring

Display name in the Platform.

status'draft' | 'active'

active publishes the deployment at once. A draft deployment cannot start conversations until you publish it.

passwordstring nullable

Optional password visitors must enter before starting.

customizationobject

Visual and conversation settings. Configure in the Platform or via JSON Patch on update.

limitsobject

Call limits and max duration.

allowed_originsstring[]

Origins allowed to load widget/embed deployments.

Example request

{
  "pal_id": "pcb7a34da5fe"
}

Response

Deployment created

deployment_idstring
pal_idstring

PAL that powers the deployment.

channel'widget' | 'embed' | 'landing-page'
status'draft' | 'active' | 'inactive'
namestring
has_passwordboolean
customizationobject
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.

limitsobject
allowed_originsstring[]
usage_totalinteger
usage_todayinteger
created_atstring date-time
updated_atstring date-time

Example response

{
  "deployment_id": "d1234567890abcdef",
  "pal_id": "pcb7a34da5fe"
}

Changes