v1

latestOpenAPI 3.0.32026-07-267015229.9 KB

Faces

List Faces

Returns all faces (photorealistic likenesses trained with Phoenix) created by the account associated with the API key.

Legacy: /v2/replicas and replica_id / replica_ids remain supported as aliases.

get/v2/faces

Query parameters

limitinteger

The number of faces to return per page.

pageinteger

The page number to return

verboseboolean

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

face_type'user' | 'system'

If set to user, the response will only include user faces. If set to system, the response will only include stock faces.

face_idsstring

A comma separated list of face ids to filter the response by. Example: face_ids=r90bbd427f71

model_namestring

Filter the list to faces trained on a specific Phoenix model (e.g. phoenix-3, phoenix-4).

Response

total_countinteger

The total number of faces given the filters provided.

Example response

{
  "data": [
    {
      "face_id": "r90bbd427f71",
      "face_name": "My Face",
      "training_progress": "100/100",
      "status": "completed",
      "face_type": "user'",
      "model_name": "phoenix-3"
    }
  ],
  "total_count": 42
}