Descriptions are in English
My Cartesia Voice Clone Quota
The key owner's Cartesia voice clone quota, before trying to create one: limit is the
cap (the plan's rule, otherwise the fallback cap of 2; null when the check refused
before counting — a clone ban, or no_subscription on a service closed to paying
from the balance), used is the clones in pending/cloning/ready, remaining
is the free slots.
When a clone cannot be created right now, can_create is false and reason is the
same code creation would return: no_subscription, voice_clone_banned (the cause
is in ban_reason) or voice_clone_quota_exceeded.
If the service is closed to the key owner (closed test), the answer is 404 with
reason: service_not_found.
Required key permission: voices.read.
On this page(2)
Possible responses
200Success. The payload is in data.
Success. The payload is in data.
{
"success": true,
"message": "Success",
"data": {
"limit": 2,
"used": 1,
"remaining": 1,
"can_create": true,
"reason": null,
"ban_reason": null
}
}Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.
A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.
datarequiredThe response payload.
object
The response payload.
The effective clone cap: the plan's rule, otherwise the fallback cap of 2. null when the check refused before counting (a clone ban, or no_subscription on a service closed to paying from the balance).
How many clones hold a slot: those in pending, cloning and ready.
Free slots: limit - used, never below 0; null when limit is null.
Whether a clone can be created right now. false — the cause is in reason.
The refusal code creation would return: no_subscription, voice_clone_banned or voice_clone_quota_exceeded; null when creation is possible.
The clone ban cause when reason is voice_clone_banned, otherwise null.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the voices.read permission.
The key lacks the voices.read permission.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
404The Cartesia service is closed to the key owner (reason: service_not_found).
The Cartesia service is closed to the key owner (reason: service_not_found).
{
"success": false,
"message": "Resource not found."
}Always false in error responses.
The reason for the rejection in words, in the account language. Meant for display; do not branch on it, the wording changes.
Machine-readable reason of a business refusal (for example, input_expired, insufficient_balance). Branch on it, not on the message text.
The same machine-readable code as in reason — a second name for the field. The values always match.
Nearby
Neighbouring operations
Feed this page to an AI
spec 0.0.1