Vai alla navigazione

Crea progetto Audio Native

Crea un progetto con Audio Native abilitato, avvia facoltativamente la conversione e restituisce l'ID del progetto e uno snippet HTML incorporabile.

Header

xi-api-keystringOpzionale

Richiesta

This endpoint expects a multipart form containing an optional file.
namestringObbligatorio
Nome del progetto.
imagestring or nullOpzionaleDeprecated

(Obsoleto) URL dell'immagine usata nel player. Se non viene fornito, viene usata l'immagine predefinita impostata nelle impostazioni del Player.

authorstring or nullOpzionale
Autore usato nel player e inserito all'inizio dell'articolo caricato. Se non fornito, viene usato l'autore predefinito configurato nelle impostazioni del Player.
titlestring or nullOpzionale
Titolo usato nel player e inserito all'inizio dell'articolo caricato. Se non viene fornito, viene usato il titolo predefinito impostato nelle impostazioni del Player.
smallbooleanOpzionalePredefinito a falseDeprecated

(Obsoleto) Indica se usare il player piccolo. Se non viene fornito, viene usato il valore predefinito impostato nelle impostazioni del Player.

text_colorstring or nullOpzionale
Colore del testo usato nel player. Se non specificato, viene usato il colore del testo predefinito impostato nelle impostazioni del Player.
background_colorstring or nullOpzionale
Colore di sfondo usato nel player. Se non fornito, viene usato il colore di sfondo predefinito configurato nelle impostazioni del Player.
sessionizationintegerOpzionalePredefinito a 0Deprecated

(Obsoleto) Specifica per quanti minuti mantenere la sessione tra i ricaricamenti della pagina. Se non viene fornito, viene usata la sessionizzazione predefinita impostata nelle impostazioni del Player.

voice_idstring or nullOpzionale
ID della voce usata per dare voce al contenuto. Se non viene fornito, viene usato l'ID della voce predefinita impostato nelle impostazioni del Player.
model_idstring or nullOpzionale
ID del modello TTS usato nel player. Se non specificato, viene usato l'ID del modello predefinito impostato nelle impostazioni del Player.
filefileOpzionale

File di input txt o HTML contenente il contenuto dell'articolo. L'HTML deve essere formattato come segue: '<html><body><div><p>Il tuo contenuto</p><h3>Altro contenuto</h3><p>Altro contenuto ancora</p></div></body></html>'

auto_convertbooleanOpzionalePredefinito a false
Indica se convertire automaticamente il progetto in audio.
apply_text_normalizationenum or nullOpzionale

Questo parametro controlla la normalizzazione del testo con quattro modalità: 'auto', 'on', 'apply_english' e 'off'. Se impostato su 'auto', il sistema deciderà automaticamente se applicare la normalizzazione del testo (ad esempio, scrivendo i numeri in lettere). Con 'on', la normalizzazione del testo verrà sempre applicata, mentre con 'off' verrà ignorata. 'apply_english' equivale a 'on', ma presume che il testo sia in inglese.

Valori consentiti:
pronunciation_dictionary_locatorslist of stringsOpzionale

Un elenco di locator dei dizionari di pronuncia (pronunciation_dictionary_id, version_id), codificati come elenco di stringhe JSON, da applicare al testo. È richiesto un elenco di stringhe codificate in JSON poiché l'aggiunta di progetti può avvenire tramite formData anziché jsonBody. Per specificare più dizionari, usa più righe --form nel comando curl, ad esempio --form 'pronunciation_dictionary_locators="{"pronunciation_dictionary_id":"Vmd4Zor6fplcA7WrINey","version_id":"hRPaxjlTdR7wFMhV4w0b"}"' --form 'pronunciation_dictionary_locators="{"pronunciation_dictionary_id":"JzWtcGQMJ6bnlWwyMo7e","version_id":"lbmwxiLu4q6txYxgdZqn"}"'.

Risposta

Risposta riuscita
project_idstring
L'ID del progetto Audio Native creato.
convertingboolean

Se il progetto è attualmente in fase di conversione.

html_snippetstring
Lo snippet HTML per incorporare il player Audio Native.

Errori

422
Unprocessable Entity Error