Create audio native project
Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
Headers
xi-api-key
Request
This endpoint expects a multipart form containing an optional file.
name
Project name.
imageDeprecated
(Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
title
Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
smallDeprecated
(Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
text_color
Text color used in the player. If not provided, default text color set in the Player settings is used.
background_color
Background color used in the player. If not provided, default background color set in the Player settings is used.
sessionizationDeprecated
(Deprecated) Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used.
voice_id
Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
model_id
TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
file
Either txt or HTML input file containing the article content. HTML should be formatted as follows ‘<html><body><div><p>Your content</p><h3>More of your content</h3><p>Some more of your content</p></div></body></html>’
auto_convert
Whether to auto convert the project to audio or not.
Response
Successful Response
project_id
The ID of the created Audio Native project.
converting
Whether the project is currently being converted.
html_snippet
The HTML snippet to embed the Audio Native player.