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 Studio, qui peut être initialisé vierge, à partir d’un document ou d’une URL.
En-têtes
xi-api-keystringOptionnel
Requête
This endpoint expects a multipart form containing an optional file.
namestringRequis
Le nom du projet Studio, utilisé uniquement à des fins d’identification.
default_title_voice_idstring or nullOptionnel
Le voice_id correspondant à la voix par défaut utilisée pour les nouveaux titres.
default_paragraph_voice_idstring or nullOptionnel
Le voice_id correspondant à la voix par défaut utilisée pour les nouveaux paragraphes.
default_model_idstring or nullOptionnel
L’ID du modèle à utiliser pour ce projet Studio. Vous pouvez interroger GET /v1/models pour répertorier tous les modèles disponibles.
from_urlstring or nullOptionnel
An optional URL from which we will extract content to initialize the Studio project. If this is set, ‘from_url’ and ‘from_content’ must be null. If neither ‘from_url’, ‘from_document’, ‘from_content’ are provided we will initialize the Studio project as blank.
from_documentfileOptionnel
An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, ‘from_url’ and ‘from_content’ must be null. If neither ‘from_url’, ‘from_document’, ‘from_content’ are provided we will initialize the Studio project as blank.
from_content_jsonstringOptionnel
Contenu facultatif pour initialiser le projet Studio. Si cette valeur est définie, « from_url » et « from_document » doivent être null. Si aucune des valeurs « from_url », « from_document » et « from_content » n’est fournie, le projet Studio sera initialisé vide.
Exemple :
[{"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 nullOptionnel
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.
Valeurs autorisées:
titlestring or nullOptionnel
Un nom facultatif de l’auteur du projet Studio. Il sera ajouté comme métadonnée au fichier MP3 lors du téléchargement du projet Studio ou d’un chapitre.
authorstring or nullOptionnel
Un nom facultatif de l’auteur du projet Studio. Il sera ajouté comme métadonnée au fichier MP3 lors du téléchargement du projet Studio ou d’un chapitre.
descriptionstring or nullOptionnel
Une description facultative du projet Studio.
genreslist of stringsOptionnel
Une liste facultative des genres associés au projet Studio.
target_audienceenum or nullOptionnel
Un public cible facultatif du projet Studio.
Valeurs autorisées:
languagestring or nullOptionnel=2 characters
Une langue facultative du projet Studio. Code de langue à deux lettres (ISO 639-1).
content_typestring or nullOptionnel
Un type de contenu facultatif du projet Studio.
original_publication_datestring or nullOptionnelformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"
Une date de publication originale facultative du projet Studio, au format AAAA-MM-JJ ou AAAA.
mature_contentboolean or nullOptionnelPar défaut false
Une indication facultative précisant si ce projet Studio contient du contenu destiné à un public averti.
isbn_numberstring or nullOptionnel
Un numéro ISBN facultatif du projet Studio que vous souhaitez créer. Il sera ajouté comme métadonnée au fichier MP3 lors du téléchargement du projet Studio ou d’un chapitre.
[Obsolète] Lors du téléchargement du projet Studio, indique si l’audio renvoyé doit faire l’objet d’un post-traitement afin de respecter les exigences de volume normalisé des livres audio.
Indique si, lors du téléchargement du projet Studio, l’audio renvoyé doit subir un post-traitement afin de respecter les exigences de volume normalisé des livres audio.
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\"}"'.
callback_urlstring or nullOptionnel
Une URL qui sera appelée par notre service lorsque le projet Studio sera converti. La requête contiendra un objet JSON indiquant l’état de la conversion.
Messages :
1. Lorsque le projet a été converti avec succès :
{
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. Lorsque la conversion du projet a échoué :
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "error",
project_snapshot_id: None,
error_details: "Détails de l’erreur si la conversion a échoué"
}
}
3. Lorsque le chapitre a été converti avec succès :
{
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. Lorsque la conversion du chapitre a échoué :
{
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: "Détails de l’erreur si la conversion a échoué"
}
}
fictionenum or nullOptionnel
Une indication facultative précisant si le contenu de ce projet Studio est une fiction.
Valeurs autorisées:
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:
auto_convertbooleanOptionnelPar défaut false
Indique s'il faut convertir automatiquement le projet Studio en audio.
auto_assign_voicesboolean or nullOptionnelPar défaut false
[Alpha Feature] Indique s’il faut attribuer automatiquement des voix aux phrases lors de la création du projet.
source_typeenum or nullOptionnel
Le type de projet Studio à créer.
voice_settingslist of stringsOptionnel
Remplacements facultatifs des paramètres vocaux du projet, encodés sous forme de liste de chaînes JSON.
Contenu facultatif pour initialiser le projet Studio. Si cette valeur est définie, « from_url » et « from_document » doivent être null. Si aucune des valeurs « from_url », « from_document » et « from_content » n’est fournie, le projet Studio sera initialisé vide.
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.
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”}”’.
Une URL qui sera appelée par notre service lorsque le projet Studio sera converti. La requête contiendra un objet JSON indiquant l’état de la conversion.
Messages :
Lorsque le projet a été converti avec succès :
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “success”,
project_snapshot_id: “22m00Tcm4TlvDq8ikMAT”,
error_details: None,
}
}
Lorsque la conversion du projet a échoué :
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “error”,
project_snapshot_id: None,
error_details: “Détails de l’erreur si la conversion a échoué”
}
}
Lorsque le chapitre a été converti avec succès :
{
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,
}
}
Lorsque la conversion du chapitre a échoué :
{
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: “Détails de l’erreur si la conversion a échoué”
}
}
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.
