Skip to main content
GET
/
project
/
assets
/
avatar
/
{id}
cURL
curl --request GET \
  --url https://api.deepreel.com/project/assets/avatar/{id}/ \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "gender": 1,
  "cropped_asset": "<string>",
  "full_asset": "<string>",
  "is_pending": true,
  "is_custom": true,
  "created_at": "2023-11-07T05:31:56Z",
  "is_colorcode_bg_supported": true,
  "languages": [
    {
      "id": 123,
      "name": "<string>",
      "is_default": true
    }
  ]
}

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)

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this avatar.

Response

Allows to specify fields to be included

​
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
​
cropped_asset
string<uri>
required
read-only

URL for the cropped asset.

​
full_asset
string<uri>
required
read-only

URL for the full asset.

​
is_pending
boolean
required
read-only

True if the Avatar has been generated else False.

​
is_custom
boolean
required
read-only

True if the Avatar is custom generated else False.

​
created_at
string<date-time>
required
read-only

DateTime when the Avatar was created.

​
is_colorcode_bg_supported
boolean
required
read-only

True if the Avatar supports a color code background else False.

​
languages
object[]
required
read-only

List of languages supported by the Avatar.