BEbey-dev
Avatars

Retrieve Avatar

Changed on

Retrieve a single avatar by ID.

get/v1/avatars/{id}

Request

  • Base URL
    https://api.bey.dev
  • URL
    https://api.bey.dev/v1/avatars/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Avatar ID.

Response

Requested Avatar

visibility'public' | 'private' required

Visibility of the resource.

idstring required

Unique identifier of the object in the database.

namestring required
status'to-train' | 'training' | 'available' | 'failed' required

Status of an avatar.

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "John Doe"
}

Changes