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.
Crée un projet compatible avec Audio Native, lance facultativement la conversion et renvoie l’ID du projet ainsi qu’un extrait HTML intégrable.
En-têtes
xi-api-keystringOptionnel
Requête
This endpoint expects a multipart form containing an optional file.
namestringRequis
Nom du projet.
imagestring or nullOptionnelDeprecated
(Obsolète) URL de l’image utilisée dans le lecteur. Si elle n’est pas fournie, l’image par défaut définie dans les paramètres du lecteur est utilisée.
authorstring or nullOptionnel
Auteur utilisé dans le lecteur et inséré au début de l’article chargé. S’il n’est pas fourni, l’auteur par défaut défini dans les paramètres du Player est utilisé.
titlestring or nullOptionnel
Titre utilisé dans le lecteur et inséré en haut de l’article importé. S’il n’est pas fourni, le titre par défaut défini dans les paramètres du Player est utilisé.
smallbooleanOptionnelPar défaut falseDeprecated
(Obsolète) Indique s’il faut utiliser le petit lecteur. Si cette valeur n’est pas fournie, la valeur par défaut définie dans les paramètres du lecteur est utilisée.
text_colorstring or nullOptionnel
Couleur de texte utilisée dans le lecteur. Si elle n’est pas fournie, la couleur de texte par défaut définie dans les paramètres du lecteur est utilisée.
background_colorstring or nullOptionnel
Couleur d’arrière-plan utilisée dans le lecteur. Si elle n’est pas fournie, la couleur d’arrière-plan par défaut définie dans les paramètres du Player est utilisée.
(Obsolète) Indique pendant combien de minutes conserver la session après le rechargement des pages. Si cette valeur n’est pas fournie, la sessionisation par défaut définie dans les paramètres du lecteur est utilisée.
voice_idstring or nullOptionnel
ID de voix utilisé pour donner une voix au contenu. S’il n’est pas fourni, l’ID de voix par défaut défini dans les paramètres du Player est utilisé.
model_idstring or nullOptionnel
ID du modèle TTS utilisé dans le lecteur. S’il n’est pas fourni, l’ID de modèle par défaut défini dans les paramètres du lecteur est utilisé.
filefileOptionnel
Fichier d’entrée au format txt ou HTML contenant le contenu de l’article. Le HTML doit être mis en forme comme suit : ‘<html><body><div><p>Votre contenu</p><h3>Davantage de contenu</h3><p>Encore plus de contenu</p></div></body></html>’
auto_convertbooleanOptionnelPar défaut false
Indique s'il faut convertir automatiquement le projet en audio.
apply_text_normalizationenum or nullOptionnel
Ce paramètre contrôle la normalisation du texte selon quatre modes : « auto », « on », « apply_english » et « off ».
Lorsqu’il est défini sur « auto », le système décide automatiquement d’appliquer ou non la normalisation du texte
(par exemple, en écrivant les nombres en toutes lettres). Avec « on », la normalisation du texte est toujours appliquée, tandis qu’avec
« off », elle est ignorée. « apply_english » est identique à « on », mais suppose que le texte est en anglais.
Valeurs autorisées:
pronunciation_dictionary_locatorslist of stringsOptionnel
Liste de localisateurs de dictionnaires de prononciation (pronunciation_dictionary_id, version_id), encodés sous forme de chaînes JSON, à appliquer au texte. Une liste de chaînes encodées en JSON est requise, car l'ajout de projets peut s'effectuer via formData plutôt que jsonBody. Pour spécifier plusieurs dictionnaires, utilisez plusieurs lignes --form dans votre commande curl, par exemple --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'.
Réponse
Réponse réussie
project_idstring
L’ID du projet Audio Native créé.
convertingboolean
Indique si le projet est actuellement en cours de conversion.
html_snippetstring
L’extrait HTML permettant d’intégrer le lecteur Audio Native.
Ce paramètre contrôle la normalisation du texte selon quatre modes : « auto », « on », « apply_english » et « off ».
Lorsqu’il est défini sur « auto », le système décide automatiquement d’appliquer ou non la normalisation du texte
(par exemple, en écrivant les nombres en toutes lettres). Avec « on », la normalisation du texte est toujours appliquée, tandis qu’avec
« off », elle est ignorée. « apply_english » est identique à « on », mais suppose que le texte est en anglais.
Liste de localisateurs de dictionnaires de prononciation (pronunciation_dictionary_id, version_id), encodés sous forme de chaînes JSON, à appliquer au texte. Une liste de chaînes encodées en JSON est requise, car l’ajout de projets peut s’effectuer via formData plutôt que jsonBody. Pour spécifier plusieurs dictionnaires, utilisez plusieurs lignes —form dans votre commande curl, par exemple —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’.
