Skip to main content
GET
/
project
/
assets
/
avatar
cURL
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>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.deepreel.com/llms.txt

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

Authorizations

​
X-API-KEY
string
header
required

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<uuid>
required
read-only

Unique Identifier of the Avatar.

​
name
string
required
read-only

Name of the Avatar.

​
gender
enum<integer>
required

Gender of the Avatar.

  • 1 - Male
  • 2 - Female
  • 3 - Non Binary
Available options:
1,
2,
3