Update avatar

Update an assistant avatar.

Request

PUT https://superinterface.ai/api/cloud/assistants/{assistantId}/avatar

Authentication

Include your private API key in the request headers:

Authorization: Bearer YOUR_PRIVATE_API_KEY

Path Parameters

Parameter	Type	Description
`assistantId`	string	The ID of the assistant

Request Body

Parameter	Type	Required	Description
`type`	`AvatarType`	Yes	Avatar type (`ICON` or `IMAGE`)
`imageAvatar`	object	Conditional	`{ url: string }` when `type` is `IMAGE`
`iconAvatar`	object	Conditional	`{ name: string }` when `type` is `ICON`

If type is ICON, iconAvatar.name must be one of:

BACKPACK

ROCKET

MAGIC_WAND

CUBE

TARGET

DISC

GLOBE

STAR

LIGHTNING_BOLT

FACE

PERSON

HEART

When type is IMAGE, provide an imageAvatar.url that the server can fetch. The image must be publicly accessible.

Example requests

Icon avatar

curl -X PUT "https://superinterface.ai/api/cloud/assistants/00cfe680-fee5-49b9-b386-6a7097eb8497/avatar" \ -H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "ICON", "iconAvatar": { "name": "LIGHTNING_BOLT" } }'

Image avatar

curl -X PUT "https://superinterface.ai/api/cloud/assistants/00cfe680-fee5-49b9-b386-6a7097eb8497/avatar" \ -H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "IMAGE", "imageAvatar": { "url": "https://example.com/avatar.png" } }'

Response

Parameter	Type	Description
`avatar`	`Avatar`	Updated avatar

Example responses

Icon avatar

{ "avatar": { "type": "ICON", "imageAvatar": null, "iconAvatar": { "name": "LIGHTNING_BOLT" } } }

Image avatar

{ "avatar": { "type": "IMAGE", "imageAvatar": { "url": "https://example.com/avatar.png" }, "iconAvatar": null } }

Errors

The endpoint may return the following errors:

401 Unauthorized

This error occurs if the API key is invalid or missing.

{ "error": "Unauthorized", "message": "Invalid or missing API key" }