GET
/
project
/
assets
/
avatar
/
curl --request GET \
  --url https://api.deepreel.com/project/assets/avatar/ \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "gender": 1
  }
]

Authorizations

X-API-KEY
string
headerrequired

Your API key with the prefix: dr_. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the account settings panel (In the bottom left corner click on your Account → profile)

Query Parameters

gender
enum<integer>

Filter the Avatars based on the Gender. Available Options 1 - Male, 2 - Female, 3 - Non Binary

Available options:
1,
2,
3
is_custom
boolean

Filter only the custom avatars.

language
integer

Id of the language. Filter the Avatars based on the language.

name
string

Filter the Avatars based on the name (partial-match and case-insensitive).

Response

200 - application/json
id
string
required

Unique Identifier of the Avatar.

name
string
required

Name of the Avatar.

gender
enum<integer>
required

Gender of the Avatar.

  • 1 - Male
  • 2 - Female
  • 3 - Non Binary
Available options:
1,
2,
3
Get Avatar PropertiesList Languages