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>",
  "agentId": {},
  "client": {}
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "identity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "thumbnailUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "client": "<string>",
  "agentId": {},
  "agent": {}
}

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.

​
agentId
object
required

Optional agent ID to link with the avatar.

​
client
object

Response

201 - application/json
​
id
string
required
​
organizationId
string
required
​
identity
string
required
​
name
string
required
​
description
string
required
​
thumbnailUrl
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
client
string
​
agentId
object
​
agent
object