ADMINISTRATIONStudio

Create Studio Project

Creates a new Studio project, it can be either initialized as blank, from a document or from a URL.

Headers

xi-api-keystringRequired

Request

This endpoint expects a multipart form containing an optional file.
namestringRequired
The name of the Studio project, used for identification only.
default_title_voice_idstringRequired

The voice_id that corresponds to the default voice used for new titles.

default_paragraph_voice_idstringRequired

The voice_id that corresponds to the default voice used for new paragraphs.

default_model_idstringRequired

The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.

from_urlstringOptional

An optional URL from which we will extract content to initialize the Studio project. If this is set, ‘from_url’ must be null. If neither ‘from_url’ or ‘from_document’ are provided we will initialize the Studio project as blank.

from_documentfileOptional

An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, ‘from_url’ must be null. If neither ‘from_url’ or ‘from_document’ are provided we will initialize the Studio project as blank.

quality_presetstringOptionalDefaults to standard

Output quality of the generated audio. Must be one of: standard - standard output format, 128kbps with 44.1kHz sample rate. high - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the credit cost by 20%. ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the credit cost by 50%. ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the credit cost by 100%.

titlestringOptional
An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
authorstringOptional
An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
descriptionstringOptional
An optional description of the Studio project.
genreslist of stringsOptional
An optional list of genres associated with the Studio project.
target_audienceenumOptional
An optional target audience of the Studio project.
Allowed values:
languagestringOptional=2 characters

An optional language of the Studio project. Two-letter language code (ISO 639-1).

content_typestringOptional
An optional content type of the Studio project.
original_publication_datestringOptionalformat: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"

An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY.

mature_contentbooleanOptionalDefaults to false
An optional specification of whether this Studio project contains mature content.
isbn_numberstringOptional
An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.
acx_volume_normalizationbooleanOptionalDefaults to false

[Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements

volume_normalizationbooleanOptionalDefaults to false
When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
pronunciation_dictionary_locatorslist of stringsOptional

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”}”’. Note that multiple dictionaries are not currently supported by our UI which will only show the first.

callback_urlstringOptional
A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion
fictionenumOptional
An optional specification of whether the content of this Studio project is fiction.
Allowed values:
apply_text_normalizationenumOptional

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:
auto_convertbooleanOptionalDefaults to false
Whether to auto convert the Studio project to audio or not.
auto_assign_voicesbooleanOptionalDefaults to false

[Alpha Feature] Whether automatically assign voices to phrases in the create Project.

source_typeenumOptional
The type of Studio project to create.
Allowed values:

Response

Successful Response
projectobject

Errors