Açıklamalar İngilizce
Archive Fish Audio Voice Clone
Retires a clone: it moves to archived, is no longer accepted by new orders, its
voice sample is deleted and its slot under the plan's cap is freed. Orders already
accepted with this voice are not affected. Idempotent: a repeated call returns the
same archived clone.
Does not check the subscription.
Required key permission: voices.write.
Bu sayfada(3)
Parametreler
Giriş alanları doğrudan istek satırında yer alır: bir değer girin, hazır URL'yi alın. Aşağıda her parametrenin türü, zorunlu olup olmadığı ve izin verilen değerleri var.
- stringyoldazorunlu
Cartesia or Fish Audio voice clone UUID — 36 characters, not a number.
Take it from the clone's
idfield:POST /voices/cartesia/clones(or/voices/fishaudio/clones) returns it on creation and the matchingGET …/cloneslists it. This is not the clone'svoice_id(that one goes into a template). Someone else's clone returns404withreason: voice_clone_not_found.Değer doğrudan yukarıdaki istek satırına yerleşir.
Olası yanıtlar
200Success. The payload is in data.
Success. The payload is in data.
{
"success": true,
"message": "Success",
"data": {
"id": "01a10e08-2ee3-73c2-88b2-8df2bcef9d1e",
"provider": "fishaudio",
"display_name": "Narrator (my voice)",
"language": "ru",
"description": null,
"status": "archived",
"voice_id": "b3f1c9a07e5d4a2c8d6e1f0a9b7c5d34",
"attempts": 1,
"error": null,
"created_at": "2026-10-14T08:02:11+00:00",
"completed_at": "2026-10-14T08:03:40+00:00",
"failed_at": null,
"banned_at": 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.
datazorunluThe clone in archived status.
FishAudioVoiceCloneFishAudioVoiceClone
The clone in archived status.
Clone UUID. Use it in /voices/fishaudio/clones/{voiceClone}/… paths; it does NOT go into a template — voice_id does.
Clone provider — always fishaudio.
Clone name given at creation.
Reference language label (ISO 639-1), or null if none was sent. It does not affect cloning.
Your description of the clone, or null.
Status: pending → cloning → ready or failed; archived — retired by the owner; banned — blocked by a moderator. Only ready can be used for narration.
The Fish Audio voice id (a 32-character hex string, not a UUID) — the value for tts_settings.voice_id of a template with service_key: fishaudio. Present only for ready, otherwise null.
Cloning attempt number: 1 on creation, +1 for every retry.
errorzorunluWhy the last attempt failed; null while there has been no failure.
null olabilirobject
Why the last attempt failed; null while there has been no failure.
Machine-readable failure code: processing_error, max_retries, network, timeout, dispatch_failed, unbanned (the clone was unbanned but had no voice). Retry with POST /voices/fishaudio/clones/{voiceClone}/retry; if processing_error keeps coming back, use a different sample.
Human-readable explanation of the failure, or null. Branch on reason, not on this text.
When the clone was created.
When the clone became ready; null until then.
When the last attempt failed; null if it has not.
When a moderator banned the clone (status = banned); null if it is not banned.
Reason for the ban given by the moderator, or null. A banned clone can be neither used nor archived.
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.write permission.
The key lacks the voices.write 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 clone does not exist or belongs to someone else (reason: voice_clone_not_found). A voiceClone that is not a UUID does not match the route: reason: endpoint_not_found (a hint with the docs address, llm.md §6.1).
The clone does not exist or belongs to someone else (reason: voice_clone_not_found). A voiceClone that is not a UUID does not match the route: reason: endpoint_not_found (a hint with the docs address, llm.md §6.1).
{
"success": false,
"message": "Voice clone not found.",
"reason": "voice_clone_not_found",
"error_code": "voice_clone_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.
İlgili içerik
Nesneler
Komşu işlemler
Daha fazla
Bu sayfayı yapay zekâya verin
spesifikasyon 0.0.1