ENDPOINTSAudio Native

Create audio native project

Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.

Headers

xi-api-keystringRequired

Request

This endpoint expects a multipart form containing an optional file.
namestringRequired
Project name.
imagestring or nullOptionalDeprecated

(Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.

authorstring or nullOptional
Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.
titlestring or nullOptional
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.
smallbooleanOptionalDefaults to falseDeprecated

(Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.

text_colorstring or nullOptional
Text color used in the player. If not provided, default text color set in the Player settings is used.
background_colorstring or nullOptional
Background color used in the player. If not provided, default background color set in the Player settings is used.
sessionizationintegerOptionalDefaults to 0Deprecated

(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_idstring or nullOptional
Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
model_idstring or nullOptional
TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
filefileOptional

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_convertbooleanOptionalDefaults to false
Whether to auto convert the project to audio or not.
apply_text_normalizationenum or nullOptional

This parameter controls text normalization with four modes: ‘auto’, ‘on’, ‘apply_english’ and ‘off’. When set to ‘auto’, the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With ‘on’, text normalization will always be applied, while with ‘off’, it will be skipped. ‘apply_english’ is the same as ‘on’ but will assume that text is in English.

Allowed values:

Response

Successful Response
project_idstring
The ID of the created Audio Native project.
convertingboolean
Whether the project is currently being converted.
html_snippetstring
The HTML snippet to embed the Audio Native player.

Errors