Atmee.aiDocs
APIAPI referenceAvatars

The avatar's portrait

GET
/v1/avatars/{avatarId}/appearance

Authorization

headerX-Api-Key<token>

Secret embed API key (sk_atmee_...; keys minted before 2026-09 carry sk_live_...), held by the customer's own backend and never sent to a browser. Format: X-Api-Key: sk_atmee_....

Path Parameters

avatarId*string
Formatuuid

Response Body

The portrait file last given, as a presigned URL.

application/json
  1. response
url?string

A presigned download URL of the file last given; null when none was given or it could not be signed.

expiresAt?string

When the URL stops working; GET again for a fresh one.

Formatdate-time
Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/appearance'
Example Response
{  "url": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Delete (soft) an avatar DELETE

Soft-deletes the avatar: it disappears from the API at once and its unfinished captures are cancelled.

Replace the avatar's portrait PUT

One image (jpg, png or webp, <= 10 MB) as the file part.