people-simpleList 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 linkarrow-up-right.

circle-exclamation

Avatar inference model and variant support

There are two different inference models supported by the API (returned by the supportedInferenceModel parameter):

  • legacy

  • neo

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

  • full_body

  • bubble

  • shoulder

circle-exclamation
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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

A list of avatars

application/json
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:
qualitystring · enumOptionalPossible values:
emotionsstring[]Optional

Deprecated field, will be removed in future versions.

default_voicestringRequired

Default voice for the avatar

get
/assets/actors

Last updated

Was this helpful?