Skip to main content
GET
/
v1
/
avatars
/
{id}
Retrieve Avatar
curl --request GET \
  --url https://api.example.com/v1/avatars/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bey.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

​
id
string
required

Avatar ID.

Response

Requested Avatar

Response model for an avatar.

​
visibility
enum<string>
required

Visibility of the resource.

Available options:
public,
private
​
id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

​
name
string
required
Examples:

"John Doe"

"Jane Smith"

​
status
enum<string>
required

Status of an avatar.

Available options:
to-train,
training,
available,
failed