TAtavus
Deployments

Get Deployment

get/v2/deployments/{deployment_id}

Request

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

Path parameters

deployment_idstring required

Deployment UUID.

Response

Deployment details

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

No recorded changes to this operation across all 2 revisions of this API.