Skip to main content
POST
/
v1
/
avatars
Create one-shot avatar
curl --request POST \
  --url https://api.anam.ai/v1/avatars \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'displayName=<string>' \
  --form imageFile='@example-file' \
  --form 'imageUrl=<string>'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
displayName
string
required

Display name for the avatar (3-50 characters)

​
imageFile
file

Image file to create the avatar from (JPEG, PNG, or WebP, max 10MB). Either imageFile or imageUrl must be provided, but not both.

​
imageUrl
string<uri>

URL of the image to create the avatar from (JPEG, PNG, or WebP, max 10MB). Either imageFile or imageUrl must be provided, but not both.

Response

Successfully created avatar