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.
Crea un nuevo proyecto de Studio, que puede inicializarse vacío, a partir de un documento o de una URL.
Encabezados
xi-api-keystringOpcional
Solicitud
This endpoint expects a multipart form containing an optional file.
namestringRequerido
El nombre del proyecto de Studio, utilizado únicamente para su identificación.
default_title_voice_idstring or nullOpcional
El voice_id que corresponde a la voz predeterminada utilizada para los nuevos títulos.
default_paragraph_voice_idstring or nullOpcional
El voice_id que corresponde a la voz predeterminada utilizada para los nuevos párrafos.
default_model_idstring or nullOpcional
El ID del modelo que se usará para este proyecto de Studio. Puedes consultar GET /v1/models para enumerar todos los modelos disponibles.
from_urlstring or nullOpcional
Una URL opcional de la que extraeremos contenido para inicializar el proyecto de Studio. Si se establece, ‘from_url’ y ‘from_content’ deben ser null. Si no se proporcionan ‘from_url’, ‘from_document’ ni ‘from_content’, inicializaremos el proyecto de Studio en blanco.
from_documentfileOpcional
Puedes proporcionar un archivo opcional .epub, .pdf, .txt o similar. Si lo proporcionas, inicializaremos el proyecto de Studio con su contenido. Si se establece, 'from_url' y 'from_content' deben ser null. Si no se proporcionan 'from_url', 'from_document' ni 'from_content', inicializaremos el proyecto de Studio en blanco.
from_content_jsonstringOpcional
Contenido opcional para inicializar el proyecto de Studio. Si se establece, 'from_url' y 'from_document' deben ser nulos. Si no se proporciona ninguno de 'from_url', 'from_document' o 'from_content', inicializaremos el proyecto de Studio en blanco.
Ejemplo:
[{"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 nullOpcional
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.
Valores permitidos:
titlestring or nullOpcional
Un nombre opcional del autor del proyecto de Studio. Se añadirá como metadato al archivo mp3 al descargar el proyecto de Studio o un capítulo.
authorstring or nullOpcional
Un nombre opcional del autor del proyecto de Studio. Se añadirá como metadato al archivo mp3 al descargar el proyecto de Studio o un capítulo.
descriptionstring or nullOpcional
Una descripción opcional del proyecto de Studio.
genreslist of stringsOpcional
Una lista opcional de géneros asociados al proyecto de Studio.
target_audienceenum or nullOpcional
Un público objetivo opcional del proyecto de Studio.
Valores permitidos:
languagestring or nullOpcional=2 characters
Un idioma opcional del proyecto de Studio. Código de idioma de dos letras (ISO 639-1).
content_typestring or nullOpcional
Un tipo de contenido opcional del proyecto de Studio.
original_publication_datestring or nullOpcionalformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"
Una fecha de publicación original opcional del proyecto de Studio, en formato YYYY-MM-DD o YYYY.
mature_contentboolean or nullOpcionalValor predeterminado: false
Una especificación opcional de si este proyecto de Studio contiene contenido para adultos.
isbn_numberstring or nullOpcional
Un número ISBN opcional del proyecto de Studio que quieres crear. Se añadirá como metadato al archivo mp3 al descargar el proyecto de Studio o un capítulo.
[Obsoleto] Indica si el audio devuelto debe aplicarse posprocesamiento al descargar el proyecto de Studio para cumplir los requisitos de volumen normalizado de los audiolibros.
Indica si, al descargar el proyecto de Studio, el audio devuelto debe tener posprocesamiento para cumplir los requisitos de volumen normalizado para audiolibros.
pronunciation_dictionary_locatorslist of stringsOpcional
Una lista de localizadores de diccionarios de pronunciación (pronunciation_dictionary_id, version_id) codificada como una lista de cadenas JSON para aplicar los diccionarios de pronunciación al texto. Se requiere una lista de cadenas codificadas en JSON, ya que los proyectos pueden añadirse mediante formData en lugar de jsonBody. Para especificar varios diccionarios, usa varias líneas --form en tu curl, como --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 nullOpcional
Una URL a la que llamará nuestro servicio cuando se convierta el proyecto de Studio. La solicitud contendrá un objeto JSON con el estado de la conversión.
Mensajes:
1. Cuando el proyecto se haya convertido correctamente:
{
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. Cuando falle la conversión del proyecto:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "error",
project_snapshot_id: None,
error_details: "Error details if conversion failed"
}
}
3. Cuando el capítulo se haya convertido correctamente:
{
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. Cuando falle la conversión del capítulo:
{
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: "Error details if conversion failed"
}
}
fictionenum or nullOpcional
Una especificación opcional de si el contenido de este proyecto de Studio es ficción.
Valores permitidos:
apply_text_normalizationenum or nullOpcional
Este parámetro controla la normalización de texto con cuatro modos: 'auto', 'on', 'apply_english' y 'off'.
Cuando se establece en 'auto', el sistema decidirá automáticamente si aplicar la normalización de texto
(por ejemplo, escribir los números con letras). Con 'on', la normalización de texto se aplicará siempre, mientras que
con 'off' se omitirá. 'apply_english' funciona igual que 'on', pero asumirá que el texto está en inglés.
Puedes proporcionar un archivo opcional .epub, .pdf, .txt o similar. Si lo proporcionas, inicializaremos el proyecto de Studio con su contenido. Si se establece, ‘from_url’ y ‘from_content’ deben ser null. Si no se proporcionan ‘from_url’, ‘from_document’ ni ‘from_content’, inicializaremos el proyecto de Studio en blanco.
Contenido opcional para inicializar el proyecto de Studio. Si se establece, ‘from_url’ y ‘from_document’ deben ser nulos. Si no se proporciona ninguno de ‘from_url’, ‘from_document’ o ‘from_content’, inicializaremos el proyecto de Studio en blanco.
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.
Una lista de localizadores de diccionarios de pronunciación (pronunciation_dictionary_id, version_id) codificada como una lista de cadenas JSON para aplicar los diccionarios de pronunciación al texto. Se requiere una lista de cadenas codificadas en JSON, ya que los proyectos pueden añadirse mediante formData en lugar de jsonBody. Para especificar varios diccionarios, usa varias líneas —form en tu curl, como —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’.
Una URL a la que llamará nuestro servicio cuando se convierta el proyecto de Studio. La solicitud contendrá un objeto JSON con el estado de la conversión.
Mensajes:
Cuando el proyecto se haya convertido correctamente:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “success”,
project_snapshot_id: “22m00Tcm4TlvDq8ikMAT”,
error_details: None,
}
}
Cuando falle la conversión del proyecto:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “error”,
project_snapshot_id: None,
error_details: “Error details if conversion failed”
}
}
Cuando el capítulo se haya convertido correctamente:
{
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,
}
}
Cuando falle la conversión del capítulo:
{
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: “Error details if conversion failed”
}
}
Este parámetro controla la normalización de texto con cuatro modos: ‘auto’, ‘on’, ‘apply_english’ y ‘off’.
Cuando se establece en ‘auto’, el sistema decidirá automáticamente si aplicar la normalización de texto
(por ejemplo, escribir los números con letras). Con ‘on’, la normalización de texto se aplicará siempre, mientras que
con ‘off’ se omitirá. ‘apply_english’ funciona igual que ‘on’, pero asumirá que el texto está en inglés.
