Skip to main content
POST
/
v1
/
avatars
Create a new Equos Avatar.
curl --request POST \
  --url https://api.equos.ai/v1/avatars \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "identity": "<string>",
  "name": "<string>",
  "refImage": "<string>",
  "client": {}
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "identity": "<string>",
  "name": "<string>",
  "client": "<string>",
  "thumbnailUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json
identity
string
required

Livekit identity of the avatar.

name
string
required
refImage
string
required

Base64 data URL of the reference image.

client
object

Response

201 - application/json
id
string
required
organizationId
string
required
identity
string
required
name
string
required
thumbnailUrl
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
client
string
I