audio-native

Creates Audio Native Enabled Project.

Changed on

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

post/v1/audio-native

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/audio-native
  • Auth
    none declared

Headers

xi-api-keystring nullable

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

Request body multipart/form-data

namestring required

Project name.

imagestring nullable

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

authorstring nullable

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 nullable

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.

smallboolean

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

text_colorstring nullable

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

background_colorstring nullable

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

sessionizationinteger

(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 nullable

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

model_idstring nullable

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

filestring binary

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_convertboolean

Whether to auto convert the project to audio or not.

apply_text_normalization'auto' | 'on' | 'off' | 'apply_english' nullable
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.
pronunciation_dictionary_locatorsstring[]

A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{"pronunciation_dictionary_id":"Vmd4Zor6fplcA7WrINey","version_id":"hRPaxjlTdR7wFMhV4w0b"}"' --form 'pronunciation_dictionary_locators="{"pronunciation_dictionary_id":"JzWtcGQMJ6bnlWwyMo7e","version_id":"lbmwxiLu4q6txYxgdZqn"}"'.

Example request

{
  "pronunciation_dictionary_locators": [
    "{\"pronunciation_dictionary_id\": \"21m00Tcm4TlvDq8ikWAM\", \"version_id\": \"BdF0s0aZ3oFoKnDYdTox\"}"
  ]
}

Response

Successful Response

project_idstring required

The ID of the created Audio Native project.

convertingboolean required

Whether the project is currently being converted.

html_snippetstring required

The HTML snippet to embed the Audio Native player.

Example response

{
  "converting": false,
  "html_snippet": "<div id='audio-native-player'></div>",
  "project_id": "JBFqnCBsd6RMkjVDRZzb"
}

Changes

  • 5b595807512cRevision changes
    • info

      api operation id Creates_Audio_Native_enabled_project__v1_audio_native_post removed and replaced with create_audio_native_project

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 503db4198a44Revision changes
    • info

      api operation id Creates_AudioNative_enabled_project__v1_audio_native_post removed and replaced with Creates_Audio_Native_enabled_project__v1_audio_native_post

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property deprecated

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data