Actors

Actors

Retrieve a list of actors

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

GEThttps://app.colossyan.com/api/v1/assets/actors

Authorization

bearerAuth

Response

200401500

A list of actors

Body

application/json

name*string

Key in the database

display_name*string

Display name of the actor

preview_url*string

URL to the actor's preview video

version*enum

v1v2

gender*enum

MaleFemale

ageinteger

Age of the actor

ethnicityActorEthnicity (enum)

CaucasianBlack / African AmericanEast AsianHispanic / LatinoSouth Asian

clothing_styleActorClothingStyle (enum)

CasualFormalSportDoctorElectrician

qualityActorTrackQuality (enum)

litestudiopictar

emotionsarray of string

Deprecated field, will be removed in future versions.

views*array of object

A list of views supported by the actor

features*object

Request

JavaScriptCurlPython

const response = await fetch('https://app.colossyan.com/api/v1/assets/actors', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "display_name": "text",
    "preview_url": "text",
    "version": "v1",
    "gender": "Male",
    "age": 0,
    "ethnicity": "Caucasian",
    "clothing_style": "Casual",
    "quality": "lite",
    "emotions": [
      "text"
    ],
    "views": [
      {
        "viewVariantType": "front",
        "aspectRatio": {
          "height": 0,
          "width": 0,
          "ratio": 0
        },
        "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": 0,
            "top": 0,
            "right": 0,
            "bottom": 0
          }
        },
        "shoulderVariantDefaults": {
          "crop": {
            "left": 0,
            "top": 0,
            "right": 0,
            "bottom": 0
          }
        }
      }
    ],
    "features": {
      "side_view": false,
      "emotions": false,
      "hand_gesture": false
    }
  }
]