Atmee.aiDocs
APIAPI referenceAvatars

The avatar's voice sample and engine

GET
/v1/avatars/{avatarId}/voice

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 voice sample last given, as a presigned URL, and the voice engine.

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
ttsProvider?string

The voice engine (voice.ttsProvider on a v1 create); every v2 avatar speaks with fish_audio.

Value in"chatterbox_v3""fish""fish_audio""elevenlabs"
Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/voice'
Example Response
{  "url": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "ttsProvider": "chatterbox_v3"}

Replace the avatar's portrait PUT

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

Replace the avatar's voice sample PUT

One 10-60 s recording of clear speech (mp3, wav, m4a, aac, ogg, flac, opus or webm, <= 12 MB) as the file part.