add_project
Create an ElevenLabs Studio project from a URL, document, or custom content to convert text into audiobooks and spoken audio.
Instructions
Create Studio Project Spends ElevenLabs credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the Studio project, used for identification only. | |
| title | No | 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. | |
| author | No | 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. | |
| genres | No | An optional list of genres associated with the Studio project. | |
| fiction | No | An optional specification of whether the content of this Studio project is fiction. | |
| from_url | No | An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. | |
| language | No | An optional language of the Studio project. Two-letter language code (ISO 639-1). | |
| description | No | An optional description of the Studio project. | |
| isbn_number | No | 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. | |
| source_type | No | The type of Studio project to create. | |
| auto_convert | No | Whether to auto convert the Studio project to audio or not. | |
| callback_url | No | 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 Messages: 1. When project was converted successfully: { type: "project_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567 | |
| content_type | No | An optional content type of the Studio project. | |
| mature_content | No | An optional specification of whether this Studio project contains mature content. | |
| quality_preset | No | 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. 'ultra' - ultra quality output format, 192kbps with 44.1kHz sample r | |
| voice_settings | No | Optional voice settings overrides for the project, encoded as a list of JSON strings. Example: ["{\"voice_id\": \"21m00Tcm4TlvDq8ikWAM\", \"stability\": 0.7, \"similarity_boost\": 0.8, \"style\": 0.5, \"speed\": 1.0, \"use_speaker_boost\": true}"] | |
| target_audience | No | An optional target audience of the Studio project. | |
| default_model_id | No | The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models. | |
| from_content_json | No | An optional content to initialize the Studio project with. If this is set, 'from_url' and 'from_document' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. Example: [{"name": "Chapter A", "blocks": [{"sub_type": "p", "no | |
| auto_assign_voices | No | [Alpha Feature] Whether automatically assign voices to phrases in the create Project. | |
| from_document_path | No | 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' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as | |
| from_document_base64 | No | Base64 contents for "from_document". Use this when the server cannot read your local disk. | |
| volume_normalization | No | When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements | |
| create_publishing_read | No | If true, creates a corresponding read for direct publishing in draft state | |
| default_title_voice_id | No | The voice_id that corresponds to the default voice used for new titles. | |
| from_document_filename | No | Filename to send for "from_document". Some endpoints infer the audio format from it. | |
| acx_volume_normalization | No | [Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements | |
| apply_text_normalization | No | 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 w | |
| original_publication_date | No | An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY. | |
| default_paragraph_voice_id | No | The voice_id that corresponds to the default voice used for new paragraphs. | |
| pronunciation_dictionary_locators | No | 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 specif |