List avatars

The endpoint will return the available avatars for your workspace.

The types of avatars the endpoint will return:

• Studio: Avatars provided by Colossyan.

• Scenario: Also provided by Colossyan, but shown with a specific scenario background.

• Instant: Custom-made avatars. To learn how to create one using the API, check out the following page ⇒Create avatar

• ssa_lite/ssa_studio: These are also custom-made avatars. To learn more, visit this link.

Important: Scenario and Instant avatars are not included by default. To access them, please contact support.

Avatar inference model and variant support

There are three different inference models supported by the API (returned by the supportedInferenceModels parameter):

• legacy

• neo

• neo2

There are multiple different avatar variants supported by the API (returned by the supportedActorTrackVariant parameter):

• full_body

• bubble

• shoulder

• fullscreen (deprecated)

• halfscreen (deprecated)

Important: Not all inference models support all avatar variants.

Avatar variant	Legacy supported	Neo supported
full_body	✅	❌
bubble	✅	✅
shoulder	✅	✅

Retrieve a list of avatars

get

Fetches a list of avatars that the user has access to.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

A list of avatars

application/json

idstringRequired

Stable ID of the underlying avatar record

namestringRequired

Key in the database

display_namestringRequired

Display name of the avatar

preview_urlstringRequired

URL to the avatar's preview video

versionstring · enumRequiredPossible values:

typestring · enumOptionalPossible values:

genderstring · enumRequiredPossible values:

ageintegerOptional

Age of the avatar

ethnicitystring · enumOptionalPossible values:

clothing_stylestring · enumOptionalPossible values:

stylestring · enumOptionalPossible values:

qualitystring · enumOptionalPossible values:

emotionsstring[]Optional

Deprecated field, will be removed in future versions.

default_voicestringRequired

Default voice for the avatar

401

Unauthorized. Authentication required.

500

Internal server error.

get/assets/actors

HTTPcURLJavaScriptPython

GET /api/v1/assets/actors HTTP/1.1
Host: app.colossyan.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "display_name": "text",
    "preview_url": "text",
    "version": "v1",
    "type": "Studio",
    "gender": "Male",
    "age": 1,
    "ethnicity": "Caucasian",
    "clothing_style": "Casual",
    "style": "Realistic",
    "quality": "lite",
    "emotions": [
      "text"
    ],
    "default_voice": "text",
    "views": [
      {
        "viewVariantType": "front",
        "aspectRatio": {
          "height": 1,
          "width": 1,
          "ratio": 1
        },
        "supportedActorTrackVariants": [
          "full_body"
        ],
        "supportedInferenceModels": [
          "legacy"
        ],
        "pictarSourceUrl": "text",
        "images": {
          "thumbnail": "text",
          "editor": "text",
          "editor-happy": "text",
          "editor-sad": "text",
          "shoulder": "text"
        },
        "videos": {
          "base": "text",
          "baseTransparent": "text",
          "dynamicPreviewUrl": "text",
          "dynamicShoulderPreviewUrl": "text"
        },
        "bubbleVariantDefaults": {
          "crop": {
            "left": 1,
            "top": 1,
            "right": 1,
            "bottom": 1
          }
        },
        "shoulderVariantDefaults": {
          "crop": {
            "left": 1,
            "top": 1,
            "right": 1,
            "bottom": 1
          }
        },
        "logoApply": {},
        "livePreviewEnabled": true
      }
    ],
    "features": {
      "side_view": true,
      "emotions": true,
      "sitting": true,
      "logo_addition": true
    }
  }
]