Add Project
Creates a new project, it can be either initialized as blank, from a document or from a URL.
Headers
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
The name of the project, used for identification only.
The voice_id that corresponds to the default voice used for new titles.
The voice_id that corresponds to the default voice used for new paragraphs.
The model_id of the model to be used for this project, you can query GET https://api.elevenlabs.io/v1/models to list all available models.
An optional URL from which we will extract content to initialize the project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the project as blank.
An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the 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 project as blank.
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%.
An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download.
An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download.
An optional description of the project.
An optional list of genres associated with the project.
An optional target audience of the project.
children, young adult, adult, all ages An optional language of the project. Two-letter language code (ISO 639-1).
2An optional content type of the project.
An optional original publication date of the project, in the format YYYY-MM-DD or YYYY.
An optional mature content of the project.
An optional ISBN number of the project you want to create, this will be added as metadata to the mp3 file on project / chapter download.
[Deprecated] When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
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.
[Deprecated] A url that will be called by our service when the project is converted with a json containing the status of the conversion
Whether to run quality check on the generated audio and regenerate if needed.
Response
Was this page helpful?