v1

latestOpenAPI 3.0.32026-07-267015229.9 KB

Faces

Get Face

This endpoint returns a single Face by its unique identifier.

get/v2/faces/{face_id}

Path parameters

face_idstring required

A unique identifier for the face.

Query parameters

verboseboolean

If set to true, the response will include additional face data such as face_type.

Response

face_idstring

A unique identifier for the face.

face_namestring

The name of the face.

thumbnail_video_urlstring

A direct link to the video that will be used as the thumbnail for the face.

training_progressstring

Training progress as a string (for example 100/100).

statusstring

Training lifecycle: started, completed, or error. On failure, this is error and error_message is populated.

created_atstring

The date and time the face was created.

updated_atstring

The date and time of when the face was last updated.

error_messagestring nullable

When status is error, contains details about the training failure; otherwise typically null.

face_typestring

If verbose query paramter is set to true. The type of face. Possible values: user, system. User faces are faces that have been created by users. System faces are stock Tavus faces that anyone may use

model_namestring

The Phoenix model the face was trained on (e.g. phoenix-3, phoenix-4).

Example response

{
  "face_id": "r90bbd427f71",
  "face_name": "My Face",
  "training_progress": "100/100",
  "status": "completed",
  "created_at": "2024-01-24T07:14:03.327Z",
  "updated_at": "2024-01-24T07:14:03.327Z",
  "face_type": "user'",
  "model_name": "phoenix-3"
}