/** * This file was auto-generated by Fern from our API Definition. */ import * as ElevenLabs from "../index"; export interface AddProjectRequest { /** The name of the Studio project, used for identification only. */ name: string; /** The voice_id that corresponds to the default voice used for new titles. */ default_title_voice_id: string; /** The voice_id that corresponds to the default voice used for new paragraphs. */ default_paragraph_voice_id: string; /** The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models. */ default_model_id: string; /** 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_url?: string; /** 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. */ from_document?: string; /** * 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%. */ quality_preset?: string; /** 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. */ title?: string; /** 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?: string; /** An optional description of the Studio project. */ description?: string; /** An optional list of genres associated with the Studio project. */ genres?: string[]; /** An optional target audience of the Studio project. */ target_audience?: ElevenLabs.BodyAddProjectV1ProjectsAddPostTargetAudience; /** An optional language of the Studio project. Two-letter language code (ISO 639-1). */ language?: string; /** An optional content type of the Studio project. */ content_type?: string; /** An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY. */ original_publication_date?: string; /** An optional specification of whether this Studio project contains mature content. */ mature_content?: boolean; /** 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. */ isbn_number?: string; /** [Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements */ acx_volume_normalization?: boolean; /** When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements */ volume_normalization?: boolean; /** 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. */ pronunciation_dictionary_locators?: string[]; /** 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 */ callback_url?: string; /** An optional specification of whether the content of this Studio project is fiction. */ fiction?: ElevenLabs.BodyAddProjectV1ProjectsAddPostFiction; /** * 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. * */ apply_text_normalization?: ElevenLabs.BodyAddProjectV1ProjectsAddPostApplyTextNormalization; /** Whether to auto convert the Studio project to audio or not. */ auto_convert?: boolean; /** [Alpha Feature] Whether automatically assign voices to phrases in the create Project. */ auto_assign_voices?: boolean; /** The type of Studio project to create. */ source_type?: ElevenLabs.BodyAddProjectV1ProjectsAddPostSourceType; }