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.

Retrieve a list of avatars

get

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

Authorizations

Responses

200

A list of avatars

application/json

401

Unauthorized. Authentication required.

500

Internal server error.

get

HTTPcURLJavaScriptPython

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

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