TAtavus
Faces

Update Face

Changed on

JSON Merge Patch on the face. Send face_name, default_voice_id, or both.

Use this to change which Voice a face speaks with after it has been created. original_voice_id is read-only, so setting default_voice_id back to it reverts the face to the voice it started with.

<Note> `PATCH /v2/faces/{face_id}/name` is a legacy route that renames a face and nothing else. It still works, so existing integrations are unaffected, but this endpoint replaces it and can change the name and the default voice in one call. </Note>
patch/v2/faces/{face_id}

Request

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

Path parameters

face_idstring required

The face identifier, e.g. rc9cff32ceba.

Request body

face_namestring

A new name for the face. Cannot be null or blank.

default_voice_idstring

The Voice this face speaks with when a PAL sets no voice of its own. Cannot be null or blank; a face with no default simply leaves nothing to resolve.

Example request

{
  "face_name": "Ana",
  "default_voice_id": "v0a1b2c3d4e5f"
}

Response

face_idstring
face_namestring
default_voice_idstring nullable
original_voice_idstring nullable

The voice this face was created with, read-only.

Example response

{
  "face_id": "rc9cff32ceba",
  "face_name": "Ana",
  "default_voice_id": "v0a1b2c3d4e5f",
  "original_voice_id": "v000000000001"
}

Changes