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 projeto com Audio Native ativado, inicia opcionalmente a conversão e retorna o ID do projeto e um trecho de HTML incorporável.
Cabeçalhos
xi-api-keystringOpcional
Solicitação
This endpoint expects a multipart form containing an optional file.
namestringObrigatório
Nome do projeto.
imagestring or nullOpcionalDeprecated
(Obsoleto) URL da imagem usada no player. Se não for fornecida, será usada a imagem padrão definida nas configurações do Player.
authorstring or nullOpcional
Autor usado no player e inserido no início do artigo enviado. Se não for informado, será usado o autor padrão definido nas configurações do Player.
titlestring or nullOpcional
Título usado no player e inserido no início do artigo enviado. Se não for fornecido, será usado o título padrão definido nas configurações do Player.
smallbooleanOpcionalPadrão é falseDeprecated
(Obsoleto) Define se deve usar o player pequeno. Se não for fornecido, será usado o valor padrão definido nas configurações do Player.
text_colorstring or nullOpcional
Cor do texto usada no player. Se não for fornecida, será usada a cor de texto padrão definida nas configurações do Player.
background_colorstring or nullOpcional
Cor de fundo usada no player. Se não for informada, será usada a cor de fundo padrão definida nas configurações do Player.
sessionizationintegerOpcionalPadrão é 0Deprecated
(Obsoleto) Especifica por quantos minutos a sessão deve persistir entre recarregamentos de página. Se não for fornecido, será usada a configuração de sessão padrão definida nas configurações do Player.
voice_idstring or nullOpcional
ID de voz usado para dar voz ao conteúdo. Se não for fornecido, será usado o ID de voz padrão definido nas configurações do Player.
model_idstring or nullOpcional
ID do modelo de TTS usado no player. Se não for fornecido, será usado o ID de modelo padrão definido nas configurações do Player.
filefileOpcional
Arquivo de entrada txt ou HTML que contém o conteúdo do artigo. O HTML deve ser formatado da seguinte forma: ‘<html><body><div><p>Seu conteúdo</p><h3>Mais do seu conteúdo</h3><p>Mais conteúdo</p></div></body></html>’
auto_convertbooleanOpcionalPadrão é false
Indica se deve converter automaticamente o projeto em áudio.
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:
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\"}"'.
Resposta
Resposta bem-sucedida
project_idstring
O ID do projeto Audio Native criado.
convertingboolean
Se o projeto está sendo convertido no momento.
html_snippetstring
O trecho de HTML para incorporar o player Audio Native.
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.
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”}”’.
