Atmee.aiDocs
APIAPI referenceAvatars

List the account's avatars

GET
/v1/avatars

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_....

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
before?string

Cursor -- return avatars created before this timestamp.

Formatdate-time

Response Body

Avatars, newest first.

application/json
  1. response
items*array<>
nextBefore?string

Pass as before to fetch the next page; null when exhausted.

Formatdate-time
Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "links": {        "chat": "http://example.com",        "profile": "http://example.com",        "studio": "http://example.com"      },      "name": "string",      "kind": "conversational",      "visibility": "private",      "moderationState": "string",      "creationSource": "string",      "status": "building",      "missingInputs": [        "image"      ],      "engine": "v1",      "thumbnailUrl": "http://example.com",      "selectionRequired": true,      "readyToChat": true,      "stall": {        "since": "2019-08-24T14:15:22Z",        "stage": "appearance",        "reason": "string"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextBefore": "2019-08-24T14:15:22Z"}

End a conversation session POST

Ends a session started with POST /v1/sessions now: the room closes and the avatar leaves.

Create an avatar (Avatar Import API) POST

Three body shapes, one result.