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.
Cria um novo projeto no Estúdio, que pode ser inicializado em branco, a partir de um documento ou de uma URL.
Cabeçalhos
xi-api-keystringOpcional
Solicitação
This endpoint expects a multipart form containing an optional file.
namestringObrigatório
O nome do projeto do Estúdio, usado apenas para identificação.
default_title_voice_idstring or nullOpcional
O voice_id correspondente à voz padrão usada em novos títulos.
default_paragraph_voice_idstring or nullOpcional
O voice_id correspondente à voz padrão usada em novos parágrafos.
default_model_idstring or nullOpcional
O ID do modelo a ser usado neste projeto do Estúdio. Você pode consultar GET /v1/models para listar todos os modelos disponíveis.
from_urlstring or nullOpcional
Uma URL opcional da qual extrairemos conteúdo para inicializar o projeto do Estúdio. Se isso for definido, ‘from_url’ e ‘from_content’ deverão ser null. Se nenhum de ‘from_url’, ‘from_document’ e ‘from_content’ for fornecido, inicializaremos o projeto do Estúdio em branco.
from_documentfileOpcional
Um arquivo opcional .epub, .pdf, .txt ou semelhante pode ser fornecido. Se fornecido, inicializaremos o projeto do Estúdio com seu conteúdo. Se isso for definido, 'from_url' e 'from_content' deverão ser null. Se nenhum de 'from_url', 'from_document' e 'from_content' for fornecido, inicializaremos o projeto do Estúdio em branco.
from_content_jsonstringOpcional
Conteúdo opcional para inicializar o projeto do Estúdio. Se definido, 'from_url' e 'from_document' devem ser nulos. Se 'from_url', 'from_document' e 'from_content' não forem fornecidos, inicializaremos o projeto do Estúdio em branco.
Exemplo:
[{"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
Um nome opcional do autor do projeto do Estúdio. Ele será adicionado como metadado ao arquivo mp3 no download do projeto ou capítulo do Estúdio.
authorstring or nullOpcional
Um nome opcional do autor do projeto do Estúdio. Ele será adicionado como metadado ao arquivo mp3 no download do projeto ou capítulo do Estúdio.
descriptionstring or nullOpcional
Uma descrição opcional do projeto do Estúdio.
genreslist of stringsOpcional
Uma lista opcional de gêneros associados ao projeto do Estúdio.
target_audienceenum or nullOpcional
Um público-alvo opcional do projeto do Estúdio.
Valores permitidos:
languagestring or nullOpcional=2 characters
Um idioma opcional do projeto do Estúdio. Código de idioma de duas letras (ISO 639-1).
content_typestring or nullOpcional
Um tipo de conteúdo opcional do projeto do Estúdio.
original_publication_datestring or nullOpcionalformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"
Uma data de publicação original opcional do projeto do Estúdio, no formato YYYY-MM-DD ou YYYY.
mature_contentboolean or nullOpcionalPadrão é false
Uma especificação opcional de se este projeto do Estúdio contém conteúdo adulto.
isbn_numberstring or nullOpcional
Um número ISBN opcional do projeto do Estúdio que você quer criar. Ele será adicionado como metadado ao arquivo mp3 no download do projeto ou capítulo do Estúdio.
acx_volume_normalizationbooleanOpcionalPadrão é false
[Obsoleto] Define se, ao baixar o projeto do Estúdio, o áudio retornado deve receber pós-processamento para atender aos requisitos de volume normalizado de audiolivros.
volume_normalizationbooleanOpcionalPadrão é false
Se, ao baixar o projeto do Estúdio, o áudio retornado deve passar por pós-processamento para atender aos requisitos de volume normalizado para audiolivros
pronunciation_dictionary_locatorslist of stringsOpcional
Uma lista de localizadores de dicionários de pronúncia (pronunciation_dictionary_id, version_id) codificada como uma lista de strings JSON, referente aos dicionários de pronúncia a serem aplicados ao texto. É necessário fornecer uma lista de strings codificadas em JSON, pois a adição de projetos pode ocorrer por meio de formData em vez de jsonBody. Para especificar vários dicionários, use várias linhas --form no 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
Uma URL que será chamada pelo nosso serviço quando o projeto do Estúdio for convertido. A solicitação conterá um objeto JSON com o status da conversão.
Mensagens:
1. Quando o projeto for convertido com sucesso:
{
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. Quando a conversão do projeto falhar:
{
type: "project_conversion_status",
event_timestamp: 1234567890,
data: {
request_id: "1234567890",
project_id: "21m00Tcm4TlvDq8ikWAM",
conversion_status: "error",
project_snapshot_id: None,
error_details: "Detalhes do erro se a conversão falhar"
}
}
3. Quando o capítulo for convertido com sucesso:
{
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. Quando a conversão do capítulo falhar:
{
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: "Detalhes do erro se a conversão falhar"
}
}
fictionenum or nullOpcional
Uma especificação opcional de se o conteúdo deste projeto do Estúdio é ficção.
Valores permitidos:
apply_text_normalizationenum or nullOpcional
Este parâmetro controla a normalização de texto com quatro modos: 'auto', 'on', 'apply_english' e 'off'.
Quando definido como 'auto', o sistema decidirá automaticamente se deve aplicar a normalização de texto
(por exemplo, escrever os números por extenso). Com 'on', a normalização de texto sempre será aplicada, enquanto
com 'off', ela será ignorada. 'apply_english' é igual a 'on', mas pressupõe que o texto está em inglês.
Valores permitidos:
auto_convertbooleanOpcionalPadrão é false
Indica se deve converter automaticamente o projeto do Estúdio em áudio.
auto_assign_voicesboolean or nullOpcionalPadrão é false
[Recurso Alfa] Define se as vozes devem ser atribuídas automaticamente às frases na criação do projeto.
source_typeenum or nullOpcional
O tipo de projeto do Estúdio a criar.
voice_settingslist of stringsOpcional
Substituições opcionais das configurações de voz do projeto, codificadas como uma lista de strings JSON.
Um arquivo opcional .epub, .pdf, .txt ou semelhante pode ser fornecido. Se fornecido, inicializaremos o projeto do Estúdio com seu conteúdo. Se isso for definido, ‘from_url’ e ‘from_content’ deverão ser null. Se nenhum de ‘from_url’, ‘from_document’ e ‘from_content’ for fornecido, inicializaremos o projeto do Estúdio em branco.
Conteúdo opcional para inicializar o projeto do Estúdio. Se definido, ‘from_url’ e ‘from_document’ devem ser nulos. Se ‘from_url’, ‘from_document’ e ‘from_content’ não forem fornecidos, inicializaremos o projeto do Estúdio em branco.
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.
Uma lista de localizadores de dicionários de pronúncia (pronunciation_dictionary_id, version_id) codificada como uma lista de strings JSON, referente aos dicionários de pronúncia a serem aplicados ao texto. É necessário fornecer uma lista de strings codificadas em JSON, pois a adição de projetos pode ocorrer por meio de formData em vez de jsonBody. Para especificar vários dicionários, use várias linhas —form no curl, como —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’.
Uma URL que será chamada pelo nosso serviço quando o projeto do Estúdio for convertido. A solicitação conterá um objeto JSON com o status da conversão.
Mensagens:
Quando o projeto for convertido com sucesso:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “success”,
project_snapshot_id: “22m00Tcm4TlvDq8ikMAT”,
error_details: None,
}
}
Quando a conversão do projeto falhar:
{
type: “project_conversion_status”,
event_timestamp: 1234567890,
data: {
request_id: “1234567890”,
project_id: “21m00Tcm4TlvDq8ikWAM”,
conversion_status: “error”,
project_snapshot_id: None,
error_details: “Detalhes do erro se a conversão falhar”
}
}
Quando o capítulo for convertido com sucesso:
{
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,
}
}
Quando a conversão do capítulo falhar:
{
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: “Detalhes do erro se a conversão falhar”
}
}
Este parâmetro controla a normalização de texto com quatro modos: ‘auto’, ‘on’, ‘apply_english’ e ‘off’.
Quando definido como ‘auto’, o sistema decidirá automaticamente se deve aplicar a normalização de texto
(por exemplo, escrever os números por extenso). Com ‘on’, a normalização de texto sempre será aplicada, enquanto
com ‘off’, ela será ignorada. ‘apply_english’ é igual a ‘on’, mas pressupõe que o texto está em inglês.
