For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Erstellt ein neues Studio-Projekt. Es kann leer, aus einem Dokument oder aus einer URL initialisiert werden.
Header
xi-api-keystringOptional
Anfrage
This endpoint expects a multipart form containing an optional file.
namestringErforderlich
Der Name des Studio-Projekts, nur zur Identifizierung.
default_title_voice_idstring or nullOptional
Die voice_id der Standardstimme für neue Titel.
default_paragraph_voice_idstring or nullOptional
Die voice_id der Standardstimme für neue Absätze.
default_model_idstring or nullOptional
Die ID des für dieses Studio-Projekt zu verwendenden Modells. Über GET /v1/models können Sie alle verfügbaren Modelle auflisten.
from_urlstring or nullOptional
Eine optionale URL, aus der wir Inhalte extrahieren, um das Studio-Projekt zu initialisieren. Wenn dies festgelegt ist, müssen ‘from_url’ und ‘from_content’ null sein. Wenn weder ‘from_url’, ‘from_document’ noch ‘from_content’ angegeben sind, initialisieren wir das Studio-Projekt leer.
from_documentfileOptional
Optional kann eine .epub-, .pdf-, .txt- oder ähnliche Datei bereitgestellt werden. Wenn sie bereitgestellt wird, initialisieren wir das Studio-Projekt mit ihrem Inhalt. Wenn dies festgelegt ist, müssen 'from_url' und 'from_content' null sein. Wenn weder 'from_url', 'from_document' noch 'from_content' angegeben sind, initialisieren wir das Studio-Projekt leer.
from_content_jsonstringOptional
Optionaler Inhalt zur Initialisierung des Studio-Projekts. Wenn dieser festgelegt ist, müssen 'from_url' und 'from_document' null sein. Wenn 'from_url', 'from_document' und 'from_content' nicht angegeben werden, initialisieren wir das Studio-Projekt leer.
Beispiel:
[{"name": "Chapter A", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "A", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "B", "type": "tts_node"}]}, {"sub_type": "h1", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "C", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "D", "type": "tts_node"}]}]}, {"name": "Chapter B", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "E", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "F", "type": "tts_node"}]}, {"sub_type": "h2", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "G", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "H", "type": "tts_node"}]}]}]
quality_presetenum or nullOptional
Output quality of the generated audio. Must be one of:
'standard' - standard output format, 128kbps with 44.1kHz sample rate.
'high' - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side.
'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
If not provided, defaults to the highest quality preset available on your subscription tier.
Erlaubte Werte:
titlestring or nullOptional
Ein optionaler Name des Autors des Studio-Projekts. Er wird beim Download des Studio-Projekts oder Kapitels als Metadaten zur MP3-Datei hinzugefügt.
authorstring or nullOptional
Ein optionaler Name des Autors des Studio-Projekts. Er wird beim Download des Studio-Projekts oder Kapitels als Metadaten zur MP3-Datei hinzugefügt.
descriptionstring or nullOptional
Eine optionale Beschreibung des Studio-Projekts.
genreslist of stringsOptional
Eine optionale Liste von Genres, die dem Studio-Projekt zugeordnet sind.
target_audienceenum or nullOptional
Eine optionale Zielgruppe des Studio-Projekts.
Erlaubte Werte:
languagestring or nullOptional=2 characters
Eine optionale Sprache des Studio-Projekts. Zweistelliger Sprachcode (ISO 639-1).
content_typestring or nullOptional
Ein optionaler Inhaltstyp des Studio-Projekts.
original_publication_datestring or nullOptionalFormat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"
Ein optionales ursprüngliches Veröffentlichungsdatum des Studio-Projekts im Format YYYY-MM-DD oder YYYY.
mature_contentboolean or nullOptionalStandardwert ist false
Eine optionale Angabe, ob dieses Studio-Projekt Inhalte für Erwachsene enthält.
isbn_numberstring or nullOptional
Eine optionale ISBN-Nummer des zu erstellenden Studio-Projekts. Sie wird beim Download des Studio-Projekts oder Kapitels als Metadaten zur MP3-Datei hinzugefügt.
acx_volume_normalizationbooleanOptionalStandardwert ist false
[Deprecated] Ob das zurückgegebene Audio beim Herunterladen des Studio-Projekts nachbearbeitet werden soll, damit es die Anforderungen an die normalisierte Lautstärke von Hörbüchern erfüllt.
volume_normalizationbooleanOptionalStandardwert ist false
Gibt an, ob das zurückgegebene Audio beim Herunterladen des Studio-Projekts nachbearbeitet werden soll, damit es die Anforderungen an die Lautstärkenormalisierung für Hörbücher erfüllt.
pronunciation_dictionary_locatorslist of stringsOptional
Eine als Liste von JSON-Strings codierte Liste von Aussprachewörterbuch-Referenzen (pronunciation_dictionary_id, version_id), die auf den Text angewendet werden. Eine Liste JSON-codierter Strings ist erforderlich, da Projekte über formData statt über jsonBody hinzugefügt werden können. Um mehrere Wörterbücher anzugeben, verwenden Sie mehrere --form-Zeilen in Ihrem curl, etwa --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'.
callback_urlstring or nullOptional
Eine URL, die von unserem Dienst aufgerufen wird, wenn das Studio-Projekt konvertiert wird. Die Anfrage enthält ein JSON-Objekt mit dem Status der Konvertierung.
Nachrichten:
1. Wenn das Projekt erfolgreich konvertiert wurde:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "success",
project_snapshot_id: "22m00Tcm4TlvDq8ikMAT",
error_details: None,
}
}
2. Wenn die Projektkonvertierung fehlgeschlagen ist:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "error",
project_snapshot_id: None,
error_details: "Fehlerdetails bei fehlgeschlagener Konvertierung"
}
}
3. Wenn das Kapitel erfolgreich konvertiert wurde:
{
type: "chapter_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
chapter_id: "22m00Tcm4TlvDq8ikMAT",
conversion_status: "success",
chapter_snapshot_id: "23m00Tcm4TlvDq8ikMAV",
error_details: None,
}
}
4. Wenn die Kapitelkonvertierung fehlgeschlagen ist:
{
type: "chapter_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
chapter_id: "22m00Tcm4TlvDq8ikMAT",
conversion_status: "error",
chapter_snapshot_id: None,
error_details: "Fehlerdetails bei fehlgeschlagener Konvertierung"
}
}
fictionenum or nullOptional
Eine optionale Angabe, ob der Inhalt dieses Studio-Projekts fiktional ist.
Erlaubte Werte:
apply_text_normalizationenum or nullOptional
Dieser Parameter steuert die Textnormalisierung mit vier Modi: 'auto', 'on', 'apply_english' und 'off'.
Bei 'auto' entscheidet das System automatisch, ob die Textnormalisierung angewendet wird
(z. B. das Ausschreiben von Zahlen). Mit 'on' wird die Textnormalisierung immer angewendet,
mit 'off' wird sie übersprungen. 'apply_english' entspricht 'on', setzt jedoch englischen Text voraus.
Erlaubte Werte:
auto_convertbooleanOptionalStandardwert ist false
Ob das Studio-Projekt automatisch in Audio konvertiert werden soll.
auto_assign_voicesboolean or nullOptionalStandardwert ist false
[Alpha Feature] Ob Phrasen beim Erstellen eines Projekts automatisch Stimmen zugewiesen werden sollen.
source_typeenum or nullOptional
Der Typ des zu erstellenden Studio-Projekts.
voice_settingslist of stringsOptional
Optionale Überschreibungen der Stimmeinstellungen für das Projekt, kodiert als Liste von JSON-Strings.
Optional kann eine .epub-, .pdf-, .txt- oder ähnliche Datei bereitgestellt werden. Wenn sie bereitgestellt wird, initialisieren wir das Studio-Projekt mit ihrem Inhalt. Wenn dies festgelegt ist, müssen ‘from_url’ und ‘from_content’ null sein. Wenn weder ‘from_url’, ‘from_document’ noch ‘from_content’ angegeben sind, initialisieren wir das Studio-Projekt leer.
Optionaler Inhalt zur Initialisierung des Studio-Projekts. Wenn dieser festgelegt ist, müssen ‘from_url’ und ‘from_document’ null sein. Wenn ‘from_url’, ‘from_document’ und ‘from_content’ nicht angegeben werden, initialisieren wir das Studio-Projekt leer.
Output quality of the generated audio. Must be one of:
‘standard’ - standard output format, 128kbps with 44.1kHz sample rate.
‘high’ - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side.
‘ultra’ - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
‘ultra_lossless’ - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
If not provided, defaults to the highest quality preset available on your subscription tier.
Eine als Liste von JSON-Strings codierte Liste von Aussprachewörterbuch-Referenzen (pronunciation_dictionary_id, version_id), die auf den Text angewendet werden. Eine Liste JSON-codierter Strings ist erforderlich, da Projekte über formData statt über jsonBody hinzugefügt werden können. Um mehrere Wörterbücher anzugeben, verwenden Sie mehrere —form-Zeilen in Ihrem curl, etwa —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’.
Eine URL, die von unserem Dienst aufgerufen wird, wenn das Studio-Projekt konvertiert wird. Die Anfrage enthält ein JSON-Objekt mit dem Status der Konvertierung.
Nachrichten:
Wenn das Projekt erfolgreich konvertiert wurde:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “success”,
project_snapshot_id: “22m00Tcm4TlvDq8ikMAT”,
error_details: None,
}
}
Wenn die Projektkonvertierung fehlgeschlagen ist:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “error”,
project_snapshot_id: None,
error_details: “Fehlerdetails bei fehlgeschlagener Konvertierung”
}
}
Wenn die Kapitelkonvertierung fehlgeschlagen ist:
{
type: “chapter_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
chapter_id: “22m00Tcm4TlvDq8ikMAT”,
conversion_status: “error”,
chapter_snapshot_id: None,
error_details: “Fehlerdetails bei fehlgeschlagener Konvertierung”
}
}
Dieser Parameter steuert die Textnormalisierung mit vier Modi: ‘auto’, ‘on’, ‘apply_english’ und ‘off’.
Bei ‘auto’ entscheidet das System automatisch, ob die Textnormalisierung angewendet wird
(z. B. das Ausschreiben von Zahlen). Mit ‘on’ wird die Textnormalisierung immer angewendet,
mit ‘off’ wird sie übersprungen. ‘apply_english’ entspricht ‘on’, setzt jedoch englischen Text voraus.
