Zum Inhalt
Lumean API

Beschreibungen auf Englisch

Die Oberfläche des Bereichs ist in Ihre Sprache übersetzt, Beschreibungen von Operationen, Schemata und Fehlern gibt es aber nur auf Russisch und Englisch — hier wird die englische Fassung angezeigt.
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.

Auf dieser Seite(2)

Mögliche Antworten

200

Success. The payload is in data.

Beispiel für den Body
{
  "success": true,
  "message": "Success",
  "data": {
    "limit": 2,
    "used": 1,
    "remaining": 1,
    "can_create": true,
    "reason": null,
    "ban_reason": null
  }
}
Felder der Antwort
successerforderlich

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
messageerforderlich

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
dataerforderlich

The response payload.

object
limiterforderlich

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

darf null sein
integer
usederforderlich

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

integer
remainingerforderlich

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

darf null sein
integer
can_createerforderlich

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

boolean
reasonerforderlich

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

darf null sein
string
ban_reasonerforderlich

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

darf null sein
string
401

The key is missing, unknown, disabled or expired.

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Felder der Antwort
successerforderlich

Always false in error responses.

boolean
messageerforderlich

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

string
dataerforderlich

Always null when the request is rejected before processing.

darf null sein
null
403

The key lacks the voices.read permission.

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Felder der Antwort
successerforderlich

Always false in error responses.

boolean
messageerforderlich

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

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "Resource not found."
}
Felder der Antwort
successerforderlich

Always false in error responses.

boolean
messageerforderlich

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

string
reasonerforderlich

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

string
error_codeerforderlich

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

string

Diese Seite einer KI geben

.md öffnenllm.md

Spezifikation 0.0.1