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 Audio-Native-fähiges Projekt, startet optional die Konvertierung und gibt die Projekt-ID sowie ein einbettbares HTML-Snippet zurück.
Header
xi-api-keystringOptional
Anfrage
This endpoint expects a multipart form containing an optional file.
namestringErforderlich
Projektname.
imagestring or nullOptionalDeprecated
(Veraltet) Im Player verwendete Bild-URL. Wenn sie nicht angegeben ist, wird das in den Player-Einstellungen festgelegte Standardbild verwendet.
authorstring or nullOptional
Autor, der im Player verwendet und am Anfang des hochgeladenen Artikels eingefügt wird. Wenn nicht angegeben, wird der in den Player-Einstellungen festgelegte Standardautor verwendet.
titlestring or nullOptional
Im Player verwendeter und oben im hochgeladenen Artikel eingefügter Titel. Wenn nicht angegeben, wird der in den Player-Einstellungen festgelegte Standardtitel verwendet.
smallbooleanOptionalStandardwert ist falseDeprecated
(Veraltet) Ob der kleine Player verwendet werden soll. Wenn nicht angegeben, wird der in den Player-Einstellungen festgelegte Standardwert verwendet.
text_colorstring or nullOptional
Im Player verwendete Textfarbe. Falls nicht angegeben, wird die in den Player-Einstellungen festgelegte Standardtextfarbe verwendet.
background_colorstring or nullOptional
Im Player verwendete Hintergrundfarbe. Wenn nicht angegeben, wird die in den Player-Einstellungen festgelegte Standardhintergrundfarbe verwendet.
sessionizationintegerOptionalStandardwert ist 0Deprecated
(Veraltet) Gibt an, für wie viele Minuten die Sitzung über Seitenneuladungen hinweg erhalten bleibt. Wenn nicht angegeben, wird die in den Player-Einstellungen festgelegte Standard-Sitzungsdauer verwendet.
voice_idstring or nullOptional
Stimmen-ID zur Vertonung des Inhalts. Wenn nicht angegeben, wird die in den Player-Einstellungen festgelegte Standard-Stimmen-ID verwendet.
model_idstring or nullOptional
Im Player verwendete TTS-Modell-ID. Wenn nicht angegeben, wird die in den Player-Einstellungen festgelegte Standard-Modell-ID verwendet.
filefileOptional
TXT- oder HTML-Eingabedatei mit dem Artikelinhalt. HTML sollte wie folgt formatiert sein: ‘<html><body><div><p>Ihr Inhalt</p><h3>Mehr von Ihrem Inhalt</h3><p>Noch mehr von Ihrem Inhalt</p></div></body></html>’
auto_convertbooleanOptionalStandardwert ist false
Ob das Projekt automatisch in Audio konvertiert werden soll.
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:
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\"}"'.
Antwort
Erfolgreiche Antwort
project_idstring
Die ID des erstellten Audio Native-Projekts.
convertingboolean
Gibt an, ob das Projekt derzeit konvertiert wird.
html_snippetstring
Das HTML-Snippet zum Einbetten des Audio Native-Players.
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.
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”}”’.
