İçeriğe geç
Lumean API

Açıklamalar İngilizce

Bölümün arayüzü dilinize çevrildi, ancak işlem, şema ve hata açıklamaları yalnızca Rusça ve İngilizce mevcut — burada İngilizce sürüm gösteriliyor.
GET/voices/fishaudio/clones/quota

My Fish Audio Voice Clone Quota

The key owner's Fish Audio 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.

Bu sayfada(2)

Olası yanıtlar

200

Success. The payload is in data.

Gövde örneği
{
  "success": true,
  "message": "Success",
  "data": {
    "limit": 2,
    "used": 1,
    "remaining": 1,
    "can_create": true,
    "reason": null,
    "ban_reason": null
  }
}
Yanıt alanları
successzorunlu

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.

boolean
messagezorunlu

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.

string
datazorunlu

The response payload.

object
limitzorunlu

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).

null olabilir
integer
usedzorunlu

How many clones hold a slot: those in pending, cloning and ready.

integer
remainingzorunlu

Free slots: limit - used, never below 0; null when limit is null.

null olabilir
integer
can_createzorunlu

Whether a clone can be created right now. false — the cause is in reason.

boolean
reasonzorunlu

The refusal code creation would return: no_subscription, voice_clone_banned or voice_clone_quota_exceeded; null when creation is possible.

null olabilir
string
ban_reasonzorunlu

The clone ban cause when reason is voice_clone_banned, otherwise null.

null olabilir
string
401

The key is missing, unknown, disabled or expired.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string
datazorunlu

Always null when the request is rejected before processing.

null olabilir
null
403

The key lacks the voices.read permission.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string
404

The Fish Audio service is closed to the key owner (reason: service_not_found).

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "Resource not found."
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

The reason for the rejection in words, in the account language. Meant for display; do not branch on it, the wording changes.

string
reasonzorunlu

Machine-readable reason of a business refusal (for example, input_expired, insufficient_balance). Branch on it, not on the message text.

string
error_codezorunlu

The same machine-readable code as in reason — a second name for the field. The values always match.

string

Bu sayfayı yapay zekâya verin

.md sürümünü açllm.md

spesifikasyon 0.0.1