Atmee.aiDocs
APIAPI referenceAvatars

Delete an older version of a v2 avatar

DELETE
/v1/avatars/{avatarId}/versions/{versionId}

Deletes every take of an older version and the files only that version uses: its takes' sink latents and preview clips, and its portrait, voice sample, voice clone, prime clip and bundle unless a kept take or the current inputs still use them. Files that any kept take or the current inputs reference are never deleted. The version cannot be restored afterwards. The current version, and a version holding the serving or selected take, cannot be deleted; nor can a version whose capture is still running (retry when it ends). When storage cannot delete the files now, the takes are still gone and pendingFiles counts what is left: repeat the DELETE to retry. Deleting the avatar deletes all of its files, every version's included.

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
versionId*string

A versionId from GET /candidates.

Match^[0-9a-f]{8}$

Response Body

Deleted.

application/json
  1. response

The takes are deleted at once. Their files (the ones only this version used) are deleted from storage in the same request; when storage fails, pendingFiles says how many are left and repeating the same DELETE (also once the version is gone) retries them.

versionId*string
deletedCandidateIds*array<>

The takes this request deleted (empty on a retry of files only).

deletedFiles*integer

How many files were deleted from storage by this request.

pendingFiles*integer

How many files could not be deleted now; repeat the DELETE to retry them. 0 when everything is gone.

Example Request
curl -X DELETE 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/string'
Example Response
{  "versionId": "string",  "deletedCandidateIds": [    "c5c499e7-a424-49c1-8487-aa808be50bac"  ],  "deletedFiles": 0,  "pendingFiles": 0}
Delete an older version of a v2 avatar — Atmee Docs