Capture more candidates
Captures count more candidates from the avatar's current bundle and
prime clip without re-running preprocessing. Captures are free for now
but count against the account's limit: at most 10 queued or running
(X-RateLimit-Limit, X-RateLimit-Remaining).
X-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_....
avatarId*stringuuidapplication/json- body
count*integer1 <= value <= 10Accepted; the new candidates start as pending.
application/json- response
items*array<>versions?array<>Every version, oldest first.
servingCandidateId?stringuuidselectedCandidateId?stringThe picked candidate. The avatar serves it once its config is built, a few seconds after the pick.
uuidgeneration*integerThe generation of the current version's takes (informational).
seedSelection*string"auto""manual"selectionRequired*booleanManual mode and a completed candidate of the current version is waiting to be promoted.
rebuilding*booleanA candidate serves while a newer version is still being built.
warning?stringSet when many candidates have been tried for one image and voice pair; usually the pair itself does not work.
curl -X POST 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/candidates' \ -H 'Content-Type: application/json' \ -d '{ "count": 1}'{ "items": [ { "candidateId": "10f4deb6-fd4e-4907-a47e-355caf6e449d", "generation": 0, "versionId": "string", "current": true, "restorable": true, "seed": 0, "status": "pending", "serving": true, "previewUrl": "http://example.com", "previewExpiresAt": "2019-08-24T14:15:22Z", "userFeedback": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "versions": [ { "versionId": "string", "current": true, "serving": true, "restorable": true, "takes": 0, "createdAt": "2019-08-24T14:15:22Z", "portraitUrl": "http://example.com", "voiceSampleUrl": "http://example.com", "previewMessage": "string", "language": "string" } ], "servingCandidateId": "908e27ac-861b-45dc-ab30-d9e3b56dc291", "selectedCandidateId": "ecabe377-180f-4e15-820f-e34d12b31008", "generation": 0, "seedSelection": "auto", "selectionRequired": true, "rebuilding": true, "warning": "string"}