Skip to main content
GET
/
v1
/
avatars
/
{id}
Retrieve Avatar
curl --request GET \
  --url https://api.bey.dev/v1/avatars/{id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.bey.dev/v1/avatars/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bey.dev/v1/avatars/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "id": "<string>",
  "name": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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