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/cartesia

Cartesia Voices

The voice catalogue of the Cartesia text-to-speech service: active voices, filterable by language (ISO 639-1), gender and a search string. Put the voice_id from the response into tts_settings.voice_id of a template with service_key: cartesia; the voice_id parameter finds one voice by its exact id — the name of a voice already chosen in a template.

voices.read

Your own cloned voice does not show up in the catalogue — its voice_id comes from GET /voices/cartesia/clones (only once the clone is ready). A voice cloned outside Lumean (for example on cartesia.ai) is accepted too: put its Cartesia id (a UUID) into tts_settings.voice_id as is.

If the service is closed to the key owner (closed testing), the answer is 404 with reason: service_not_found.

Required key permission: voices.read.

Auf dieser Seite(3)

Parameter

Die Eingabefelder liegen direkt in der Anfragezeile: Wert eintragen und die URL ist fertig. Darunter stehen Typ, Pflichtangabe und erlaubte Werte jedes Parameters.

GEThttps://api.lumean.app/api/public/voices/cartesia
  • stringin der Queryoptional≤ 16 Zeichen

    Voice language, an ISO 639-1 code (ru, en, …).

  • stringin der Queryoptional≤ 32 Zeichen

    Voice gender in the Cartesia catalogue spelling (masculine, feminine, gender_neutral).

  • stringin der Queryoptional≤ 255 Zeichen

    Search by voice name and description.

  • stringin der Queryoptional≤ 255 Zeichen

    Exact voice voice_id — look up the name and preview of a voice already chosen in a template without paging through the catalogue. A voice withdrawn from the catalogue is not returned: the list is empty.

  • integerin der Queryoptional≥ 1

    Page number, starting at 1.

  • integerin der Queryoptional1..200

    How many records to return per page. Pagination metadata sits next to items: current_page, last_page, per_page, total.

Mögliche Antworten

200

Success. The payload is in data.

Beispiel für den Body
{
  "success": true,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": 12,
        "voice_id": "a0e99841-438c-4a64-b679-ae501e7d6091",
        "name": "Russian Narrator",
        "description": "Calm male narrator for audiobooks.",
        "language": "ru",
        "gender": "masculine",
        "preview_url": "https://files.cartesia.ai/previews/a0e99841-438c-4a64-b679-ae501e7d6091.wav"
      },
      {
        "id": 13,
        "voice_id": "2ee87190-8f84-4925-97da-e52547f9462c",
        "name": "Warm Storyteller",
        "description": null,
        "language": "ru",
        "gender": "feminine",
        "preview_url": null
      }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 50,
    "total": 2
  }
}
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
itemserforderlich

Cartesia catalogue voices on this page.

array<CartesiaVoice>CartesiaVoice
Array-Element
iderforderlich

Internal id of the catalogue entry. Not needed for narration — voice_id goes into the template.

string
voice_iderforderlich

The Cartesia voice id — the value for tts_settings.voice_id of a template with service_key: cartesia.

string
nameerforderlich

Voice name.

string
descriptionerforderlich

Voice description from Cartesia, or null.

string
languageerforderlich

Voice language (ISO 639-1), or null.

string
gendererforderlich

Voice gender: masculine, feminine, gender_neutral, or null.

string
preview_urlerforderlich

Link to a voice preview recording, or null.

string
current_pageerforderlich

Current page number, starting from one.

integer
last_pageerforderlich

Number of the last page.

integer
per_pageerforderlich

Page size the server applied.

integer
totalerforderlich

Total number of records matching the filter.

integer
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 Cartesia service is closed to the key owner (reason: service_not_found).

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "Service not found.",
  "reason": "service_not_found",
  "error_code": "service_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
422

Validation error, for example per_page above 200. Offending fields are listed in errors.

Diese Antwort analysieren
Beispiel für den Body
{
  "message": "string",
  "errors": {}
}
Felder der Antwort
messageerforderlich

Errors overview.

string
errorserforderlich

A detailed description of each field that failed validation.

object
*optional
beliebige Schlüssel
array<string>

In der Nähe

Benachbarte Operationen

Diese Seite einer KI geben

.md öffnenllm.md

Spezifikation 0.0.1