POST
/
v1
/
audio-native

Headers

xi-api-key
string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Body

multipart/form-data
name
string
required

Project name.

image
string

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

author
string

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.

title
string

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.

small
boolean
default: false

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

text_color
string

Text color used in the player. If not provided, default text color set in the Player settings is used.

background_color
string

Background color used in the player. If not provided, default background color set in the Player settings is used.

sessionization
integer
default: 0

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
string

Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.

model_id
string

TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.

file
file

Either txt or HTML input file containing the article content. HTML should be formatted as follows '<html><body><div><p>Your content</p><h5>More of your content</h5><p>Some more of your content</p></div></body></html>'

auto_convert
boolean
default: false

Whether to auto convert the project to audio or not.

Response

200 - application/json
project_id
string
required
converting
boolean
required
html_snippet
string
required