Utwórz projekt Audio Native

Tworzy projekt z włączonym Audio Native, opcjonalnie rozpoczyna konwersję i zwraca identyfikator projektu oraz osadzalny fragment HTML.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects a multipart form containing an optional file.
namestringWymagany
Nazwa projektu.
imagestring or nullOpcjonalnyDeprecated

(Wycofane) Adres URL obrazu używanego w odtwarzaczu. Jeśli go nie podasz, użyjemy domyślnego obrazu ustawionego w ustawieniach Playera.

authorstring or nullOpcjonalny

Autor używany w odtwarzaczu i dodawany na początku przesłanego artykułu. Jeśli go nie podasz, użyjemy domyślnego autora z ustawień odtwarzacza.

titlestring or nullOpcjonalny

Tytuł używany w odtwarzaczu i wstawiany na początku przesłanego artykułu. Jeśli go nie podasz, użyty zostanie domyślny tytuł z ustawień Playera.

smallbooleanOpcjonalnyDomyślnie falseDeprecated

(Wycofane) Określa, czy używać małego odtwarzacza. Jeśli nie podasz tej wartości, użyjemy wartości domyślnej z ustawień Playera.

text_colorstring or nullOpcjonalny

Kolor tekstu używany w odtwarzaczu. Jeśli nie podano, używany jest domyślny kolor tekstu ustawiony w ustawieniach Playera.

background_colorstring or nullOpcjonalny

Kolor tła używany w odtwarzaczu. Jeśli go nie podasz, użyjemy domyślnego koloru tła z ustawień odtwarzacza.

sessionizationintegerOpcjonalnyDomyślnie 0Deprecated

(Wycofane) Określa, przez ile minut zachować sesję po ponownym załadowaniu strony. Jeśli nie podasz tej wartości, użyjemy domyślnego ustawienia sesji z ustawień Playera.

voice_idstring or nullOpcjonalny

ID głosu używanego do odczytania treści. Jeśli nie zostanie podane, użyte będzie domyślne ID głosu ustawione w ustawieniach Playera.

model_idstring or nullOpcjonalny

Identyfikator modelu TTS używany w odtwarzaczu. Jeśli go nie podasz, użyty zostanie domyślny identyfikator modelu z ustawień Playera.

filefileOpcjonalny

Plik wejściowy txt lub HTML zawierający treść artykułu. HTML powinien mieć format: „<html><body><div><p>Twoja treść</p><h3>Więcej treści</h3><p>Jeszcze więcej treści</p></div></body></html>”

auto_convertbooleanOpcjonalnyDomyślnie false

Czy automatycznie konwertować projekt na audio.

apply_text_normalizationenum or nullOpcjonalny
Ten parametr steruje normalizacją tekstu w czterech trybach: 'auto', 'on', 'apply_english' i 'off'. Przy wartości 'auto' system automatycznie zdecyduje, czy zastosować normalizację tekstu (np. zapis liczb słownie). Przy 'on' normalizacja tekstu będzie zawsze stosowana, a przy 'off' zostanie pominięta. 'apply_english' działa tak samo jak 'on', ale zakłada, że tekst jest po angielsku.
Dozwolone wartości:
pronunciation_dictionary_locatorslist of stringsOpcjonalny
Lista lokalizatorów słowników wymowy (pronunciation_dictionary_id, version_id) zakodowanych jako lista ciągów JSON dla słowników wymowy stosowanych do tekstu. Lista ciągów zakodowanych w JSON jest wymagana, ponieważ projekty można dodawać przez formData zamiast jsonBody. Aby podać kilka słowników, użyj kilku wierszy --form w curl, na przykład --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'.

Odpowiedź

Pomyślna odpowiedź

project_idstring
ID utworzonego projektu Audio Native.
convertingboolean
Czy projekt jest obecnie konwertowany.
html_snippetstring
Fragment HTML do osadzenia odtwarzacza Audio Native.

Błędy

422
Unprocessable Entity Error