Atmee.aiDocs
APIAPI referenceAvatars

Replace the avatar's voice sample

PUT
/v1/avatars/{avatarId}/voice

One 10-60 s recording of clear speech (mp3, wav, m4a, aac, ogg, flac, opus or webm, <= 12 MB) as the file part. Silence, pure tones or heavy noise fail the voice stage. Or, on an instance that keeps uploads (where POST /v1/uploads answers), application/json: {"voice": "<https URL | upload:<uploadId>>"}, the sample by URL or by a voice upload, consumed when the replacement succeeds. Re-runs only the build stages that depend on this part; poll GET /v1/avatars/{avatarId} for progress. Requires avatars:write. A draft is given its voice this way; on v2 it captures the first candidate once the portrait is there too.

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

Request Body

  1. body
file*file
Formatbinary

Response Body

Accepted; the affected build stages re-run.

application/json
  1. response
avatarId*string
Formatuuid
status*"building"
Value in"building"
Example Request
curl -X PUT 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/voice' \  -H 'Content-Type: application/json' \  -d '{  "voice": "string"}'
Example Response
{  "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",  "status": "building"}
Replace the avatar's voice sample — Atmee Docs