Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.elevenlabs.io
/v1/pronunciation-dictionaries
Get a list of the pronunciation dictionaries you have access to and their metadata
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| cursor | query | optional | string | Used for fetching next page. Cursor is returned in the response. |
| page_size | query | optional | integer | How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30. |
| xi-api-key | header | optional | string | 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. |
GET /v1/pronunciation-dictionaries
/v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download
Get PLS file with a pronunciation dictionary version rules
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| dictionary_id | path | required | string | The id of the pronunciation dictionary |
| version_id | path | required | string | The id of the version of the pronunciation dictionary |
| xi-api-key | header | optional | string | 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. |
GET /v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download
/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}
Get metadata for a pronunciation dictionary
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| pronunciation_dictionary_id | path | required | string | The id of the pronunciation dictionary |
| xi-api-key | header | optional | string | 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. |
GET /v1/pronunciation-dictionaries/{pronunciation_dictionary_id}
/v1/dubbing/{dubbing_id}
Returns metadata about a dubbing project, including whether it's still in progress or not
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| dubbing_id | path | required | string | ID of the dubbing project. |
| xi-api-key | header | optional | string | 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. |
GET /v1/dubbing/{dubbing_id}
/v1/dubbing/{dubbing_id}/audio/{language_code}
Returns dubbed file as a streamed file. Videos will be returned in MP4 format and audio only dubs will be returned in MP3.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| dubbing_id | path | required | string | ID of the dubbing project. |
| language_code | path | required | string | ID of the language. |
| xi-api-key | header | optional | string | 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. |
GET /v1/dubbing/{dubbing_id}/audio/{language_code}
/v1/models
Gets a list of available models.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| xi-api-key | header | optional | string | 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. |
GET /v1/models
/v1/projects
Returns a list of your projects together and its metadata.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| xi-api-key | header | optional | string | 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. |
GET /v1/projects
/v1/projects/{project_id}
Returns information about a specific project. This endpoint returns more detailed information about a project than GET api.elevenlabs.io/v1/projects.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects. |
| xi-api-key | header | optional | string | 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. |
GET /v1/projects/{project_id}
/v1/projects/{project_id}/chapters
Returns a list of your chapters for a project together and its metadata.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects. |
| xi-api-key | header | optional | string | 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. |
GET /v1/projects/{project_id}/chapters
/v1/projects/{project_id}/chapters/{chapter_id}
Returns information about a specific chapter.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects. |
| chapter_id | path | required | string | The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project. |
| xi-api-key | header | optional | string | 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. |
GET /v1/projects/{project_id}/chapters/{chapter_id}
/v1/projects/{project_id}/chapters/{chapter_id}/snapshots
Gets information about all the snapshots of a chapter, each snapshot corresponds can be downloaded as audio. Whenever a chapter is converted a snapshot will be automatically created.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects. |
| chapter_id | path | required | string | The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project. |
| xi-api-key | header | optional | string | 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. |
GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots
/v1/projects/{project_id}/snapshots
Gets the snapshots of a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects. |
| xi-api-key | header | optional | string | 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. |
GET /v1/projects/{project_id}/snapshots
/docs
GET /docs
/v1/voices/{voice_id}/samples/{sample_id}/audio
Returns the audio corresponding to a sample attached to a voice.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| voice_id | path | required | string | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. |
| sample_id | path | required | string | Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice. |
| xi-api-key | header | optional | string | 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. |
GET /v1/voices/{voice_id}/samples/{sample_id}/audio
/v1/history
Returns metadata about all your generated audio.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_size | query | optional | integer | How many history items to return at maximum. Can not exceed 1000, defaults to 100. |
| start_after_history_item_id | query | optional | string | After which ID to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date. |
| voice_id | query | optional | string | Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs. |
| xi-api-key | header | optional | string | 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. |
GET /v1/history
/v1/history/{history_item_id}
Returns information about an history item by its ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| history_item_id | path | required | string | History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. |
| xi-api-key | header | optional | string | 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. |
GET /v1/history/{history_item_id}
/v1/history/{history_item_id}/audio
Returns the audio of an history item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| history_item_id | path | required | string | History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. |
| xi-api-key | header | optional | string | 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. |
GET /v1/history/{history_item_id}/audio
/v1/user
Gets information about the user
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| xi-api-key | header | optional | string | 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. |
GET /v1/user
/v1/user/subscription
Gets extended information about the users subscription
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| xi-api-key | header | optional | string | 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. |
GET /v1/user/subscription
/v1/voice-generation/generate-voice/parameters
Get possible parameters for the /v1/voice-generation/generate-voice endpoint.
GET /v1/voice-generation/generate-voice/parameters
/v1/shared-voices
Gets a list of shared voices.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_size | query | optional | integer | How many shared voices to return at maximum. Can not exceed 100, defaults to 30. |
| category | query | optional | string | voice category used for filtering |
| gender | query | optional | string | gender used for filtering |
| age | query | optional | string | age used for filtering |
| accent | query | optional | string | accent used for filtering |
| language | query | optional | string | language used for filtering |
| search | query | optional | string | search term used for filtering |
| use_cases | query | optional | array | use-case used for filtering |
| descriptives | query | optional | array | search term used for filtering |
| featured | query | optional | boolean | Filter featured voices |
| reader_app_enabled | query | optional | boolean | Filter voices that are enabled for the reader app |
| owner_id | query | optional | string | Filter voices by public owner ID |
| sort | query | optional | string | sort criteria |
| page | query | optional | integer | |
| xi-api-key | header | optional | string | 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. |
GET /v1/shared-voices
/v1/voices
Gets a list of all available voices for a user.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| xi-api-key | header | optional | string | 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. |
GET /v1/voices
/v1/voices/settings/default
Gets the default settings for voices. "similarity_boost" corresponds to"Clarity + Similarity Enhancement" in the web app and "stability" corresponds to "Stability" slider in the web app.
GET /v1/voices/settings/default
/v1/voices/{voice_id}
Returns metadata about a specific voice.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| voice_id | path | required | string | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. |
| with_settings | query | optional | boolean | If set will return settings information corresponding to the voice, requires authorization. |
| xi-api-key | header | optional | string | 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. |
GET /v1/voices/{voice_id}
/v1/voices/{voice_id}/settings
Returns the settings for a specific voice. "similarity_boost" corresponds to"Clarity + Similarity Enhancement" in the web app and "stability" corresponds to "Stability" slider in the web app.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| voice_id | path | required | string | Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. |
| xi-api-key | header | optional | string | 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. |
GET /v1/voices/{voice_id}/settings
/admin/{admin_url_prefix}/sso-provider
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workspace_id | query | required | string |
GET /admin/{admin_url_prefix}/sso-provider
AddProjectResponseModel
{
"type": "object",
"title": "AddProjectResponseModel",
"required": [
"project"
],
"properties": {
"project": {
"$ref": "#/components/schemas/ProjectResponseModel"
}
}
}
AddPronunciationDictionaryResponseModel
{
"type": "object",
"title": "AddPronunciationDictionaryResponseModel",
"required": [
"id",
"name",
"created_by",
"creation_time_unix",
"version_id"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"version_id": {
"type": "string",
"title": "Version Id"
},
"description": {
"type": "string",
"title": "Description"
},
"creation_time_unix": {
"type": "integer",
"title": "Creation Time Unix"
}
}
}
AddPronunciationDictionaryRulesResponseModel
{
"type": "object",
"title": "AddPronunciationDictionaryRulesResponseModel",
"required": [
"id",
"version_id"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"version_id": {
"type": "string",
"title": "Version Id"
}
}
}
AddVoiceResponseModel
{
"type": "object",
"title": "AddVoiceResponseModel",
"required": [
"voice_id"
],
"properties": {
"voice_id": {
"type": "string",
"title": "Voice Id"
}
}
}
AudioNativeCreateProjectResponseModel
{
"type": "object",
"title": "AudioNativeCreateProjectResponseModel",
"required": [
"project_id",
"converting",
"html_snippet"
],
"properties": {
"converting": {
"type": "boolean",
"title": "Converting"
},
"project_id": {
"type": "string",
"title": "Project Id"
},
"html_snippet": {
"type": "string",
"title": "Html Snippet"
}
}
}
Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post
{
"type": "object",
"title": "Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post",
"required": [
"name"
],
"properties": {
"file": {
"type": "string",
"title": "File",
"format": "binary",
"description": "A lexicon .pls file which we will use to initialize the project with."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the pronunciation dictionary, used for identification only."
},
"description": {
"type": "string",
"title": "Description",
"description": "A description of the pronunciation dictionary, used for identification only."
}
}
}
Body_Add_project_v1_projects_add_post
{
"type": "object",
"title": "Body_Add_project_v1_projects_add_post",
"required": [
"name",
"default_title_voice_id",
"default_paragraph_voice_id",
"default_model_id",
"pronunciation_dictionary_locators"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the project, used for identification only."
},
"title": {
"type": "string",
"title": "Title",
"description": "An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."
},
"author": {
"type": "string",
"title": "Author",
"description": "An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."
},
"from_url": {
"type": "string",
"title": "From Url",
"description": "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."
},
"isbn_number": {
"type": "string",
"title": "Isbn Number",
"description": "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."
},
"callback_url": {
"type": "string",
"title": "Callback Url",
"description": "A url that will be called by our service when the project is converted with a json containing the status of the conversion",
"include_in_schema": false
},
"from_document": {
"type": "string",
"title": "From Document",
"format": "binary",
"description": "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."
},
"quality_preset": {
"type": "string",
"title": "Quality of the generated audio.",
"default": "standard",
"description": "Output quality of the generated audio. Must be one of:\nstandard - standard output format, 128kbps with 44.1kHz sample rate.\nhigh - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the character cost by 20%.\nultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the character cost by 50%.\nultra 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 character cost by 100%.\n",
"include_in_schema": true
},
"default_model_id": {
"type": "string",
"title": "Default Model Id",
"description": "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."
},
"volume_normalization": {
"type": "boolean",
"title": "Volume Normalization",
"default": false,
"description": "When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements"
},
"default_title_voice_id": {
"type": "string",
"title": "Default Title Voice Id",
"description": "The voice_id that corresponds to the default voice used for new titles."
},
"acx_volume_normalization": {
"type": "boolean",
"title": "Acx Volume Normalization",
"default": false,
"description": "[Deprecated] When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements",
"include_in_schema": false
},
"default_paragraph_voice_id": {
"type": "string",
"title": "Default Paragraph Voice Id",
"description": "The voice_id that corresponds to the default voice used for new paragraphs."
},
"pronunciation_dictionary_locators": {
"type": "array",
"items": {
"type": "string"
},
"title": "Pronunciation Dictionary Locators",
"description": "A list of pronunciation dictionary locators (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"
}
}
}
Body_Add_rules_to_the_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id__add_rules_post
{
"type": "object",
"title": "Body_Add_rules_to_the_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id__add_rules_post",
"required": [
"rules"
],
"properties": {
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/PronunciationDictionaryAliasRuleRequestModel"
},
{
"$ref": "#/components/schemas/PronunciationDictionaryPhonemeRuleRequestModel"
}
]
},
"title": "Rules",
"description": "List of pronunciation rules. Rule can be either:\n an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }\n or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }"
}
}
}
Body_Add_sharing_voice_v1_voices_add__public_user_id___voice_id__post
{
"type": "object",
"title": "Body_Add_sharing_voice_v1_voices_add__public_user_id___voice_id__post",
"required": [
"new_name"
],
"properties": {
"new_name": {
"type": "string",
"title": "New Name",
"description": "The name that identifies this voice. This will be displayed in the dropdown of the website."
}
}
}
Body_Add_voice_v1_voices_add_post
{
"type": "object",
"title": "Body_Add_voice_v1_voices_add_post",
"required": [
"name",
"files"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name that identifies this voice. This will be displayed in the dropdown of the website."
},
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"title": "Files",
"description": "One or more audio files to clone the voice from"
},
"labels": {
"type": "string",
"title": "Labels",
"description": "Serialized labels dictionary for the voice."
},
"description": {
"type": "string",
"title": "Description",
"description": "How would you describe the voice?"
}
}
}
Body_Create_a_previously_generated_voice_v1_voice_generation_create_voice_post
{
"type": "object",
"title": "Body_Create_a_previously_generated_voice_v1_voice_generation_create_voice_post",
"required": [
"voice_name",
"voice_description",
"generated_voice_id"
],
"properties": {
"labels": {
"name": "Voice metadata",
"type": "object",
"title": "Labels",
"description": "Optional, metadata to add to the created voice. Defaults to None.",
"additionalProperties": {
"type": "string"
}
},
"voice_name": {
"type": "string",
"title": "Voice Name",
"description": "Name to use for the created voice."
},
"voice_description": {
"type": "string",
"title": "Voice Description",
"description": "Description to use for the created voice."
},
"generated_voice_id": {
"type": "string",
"title": "Generated Voice Id",
"description": "The generated_voice_id to create, call POST /v1/voice-generation/generate-voice and fetch the generated_voice_id from the response header if don't have one yet."
}
}
}
Body_Creates_AudioNative_enabled_project__v1_audio_native_post
{
"type": "object",
"title": "Body_Creates_AudioNative_enabled_project__v1_audio_native_post",
"required": [
"name",
"file"
],
"properties": {
"file": {
"type": "string",
"title": "File",
"format": "binary",
"description": "Either txt or HTML input file containing the article content. HTML should be formatted as follows '<html><body><div><p>Your content</p><h5>More of your content</h5><p>Some more of your content</p></div></body></html>'"
},
"name": {
"type": "string",
"title": "Name",
"description": "Project name."
},
"image": {
"type": "string",
"title": "Image",
"description": "Image URL used in the player. If not provided, default image set in the Player settings is used."
},
"small": {
"type": "boolean",
"title": "Small",
"default": false,
"description": "Whether to use small player or not. If not provided, default value set in the Player settings is used."
},
"title": {
"type": "string",
"title": "Title",
"description": "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."
},
"author": {
"type": "string",
"title": "Author",
"description": "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."
},
"model_id": {
"type": "string",
"title": "Model Id",
"description": "TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used."
},
"voice_id": {
"type": "string",
"title": "Voice Id",
"description": "Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used."
},
"text_color": {
"type": "string",
"title": "Text Color",
"description": "Text color used in the player. If not provided, default text color set in the Player settings is used."
},
"auto_convert": {
"type": "boolean",
"title": "Auto Convert",
"default": false,
"description": "Whether to auto convert the project to audio or not."
},
"sessionization": {
"type": "integer",
"title": "Sessionization",
"default": 0,
"description": "Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used."
},
"background_color": {
"type": "string",
"title": "Background Color",
"description": "Background color used in the player. If not provided, default background color set in the Player settings is used."
}
}
}
Body_Download_history_items_v1_history_download_post
{
"type": "object",
"title": "Body_Download_history_items_v1_history_download_post",
"required": [
"history_item_ids"
],
"properties": {
"output_format": {
"type": "string",
"title": "Output Format",
"description": "Output format to transcode the audio file, can be wav or default."
},
"history_item_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "History Item Ids",
"description": "A list of history items to download, you can get IDs of history items and other metadata using the GET https://api.elevenlabs.io/v1/history endpoint."
}
}
}
Body_Dub_a_video_or_an_audio_file_v1_dubbing_post
{
"type": "object",
"title": "Body_Dub_a_video_or_an_audio_file_v1_dubbing_post",
"properties": {
"file": {
"type": "string",
"title": "File",
"format": "binary",
"description": "One or more audio files to clone the voice from"
},
"mode": {
"type": "string",
"title": "Mode",
"description": "automatic or manual."
},
"name": {
"type": "string",
"title": "Name",
"description": "Name of the dubbing project."
},
"csv_file": {
"type": "string",
"title": "Csv File",
"format": "binary",
"description": "CSV file containing transcription/translation metadata"
},
"end_time": {
"type": "integer",
"title": "End Time",
"description": "End time of the source video/audio file."
},
"watermark": {
"type": "boolean",
"title": "Watermark",
"default": false,
"description": "Whether to apply watermark to the output video."
},
"source_url": {
"type": "string",
"title": "Source Url",
"description": "URL of the source video/audio file."
},
"start_time": {
"type": "integer",
"title": "Start Time",
"description": "Start time of the source video/audio file."
},
"source_lang": {
"type": "string",
"title": "Source Lang",
"default": "auto",
"description": "Source language."
},
"target_lang": {
"type": "string",
"title": "Target Lang",
"description": "The Target language to dub the content into. Can be none if dubbing studio editor is enabled and running manual mode"
},
"num_speakers": {
"type": "integer",
"title": "Num Speakers",
"default": 0,
"description": "Number of speakers to use for the dubbing."
},
"dubbing_studio": {
"type": "boolean",
"title": "Dubbing Studio",
"default": false,
"description": "Whether to prepare dub for edits in dubbing studio."
},
"highest_resolution": {
"type": "boolean",
"title": "Highest Resolution",
"default": false,
"description": "Whether to use the highest resolution available."
},
"background_audio_file": {
"type": "string",
"title": "Background Audio File",
"format": "binary",
"description": "For use only with csv input"
},
"foreground_audio_file": {
"type": "string",
"title": "Foreground Audio File",
"format": "binary",
"description": "For use only with csv input"
}
}
}
Body_Edit_voice_v1_voices__voice_id__edit_post
{
"type": "object",
"title": "Body_Edit_voice_v1_voices__voice_id__edit_post",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name that identifies this voice. This will be displayed in the dropdown of the website."
},
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"title": "Files",
"description": "Audio files to add to the voice"
},
"labels": {
"type": "string",
"title": "Labels",
"description": "Serialized labels dictionary for the voice."
},
"description": {
"type": "string",
"title": "Description",
"description": "How would you describe the voice?"
}
}
}
Body_Generate_a_random_voice_v1_voice_generation_generate_voice_post
{
"type": "object",
"title": "Body_Generate_a_random_voice_v1_voice_generation_generate_voice_post",
"required": [
"gender",
"accent",
"age",
"accent_strength",
"text"
],
"properties": {
"age": {
"enum": [
"young",
"middle_aged",
"old"
],
"type": "string",
"title": "Age",
"description": "Category code corresponding to the age of the generated voice. Possible values: young, middle_aged, old."
},
"text": {
"type": "string",
"title": "Text",
"description": "Text to generate, text length has to be between 100 and 1000."
},
"accent": {
"type": "string",
"title": "Accent",
"description": "Category code corresponding to the accent of the generated voice. Possible values: american, british, african, australian, indian."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"title": "Gender",
"description": "Category code corresponding to the gender of the generated voice. Possible values: female, male."
},
"accent_strength": {
"type": "number",
"title": "Accent Strength",
"description": "The strength of the accent of the generated voice. Has to be between 0.3 and 2.0."
}
}
}
Body_Remove_rules_from_the_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id__remove_rules_post
{
"type": "object",
"title": "Body_Remove_rules_from_the_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id__remove_rules_post",
"required": [
"rule_strings"
],
"properties": {
"rule_strings": {
"type": "array",
"items": {
"type": "string"
},
"title": "Rule Strings",
"description": "List of strings to remove from the pronunciation dictionary."
}
}
}
Body_Speech_to_Speech_Streaming_v1_speech_to_speech__voice_id__stream_post
{
"type": "object",
"title": "Body_Speech_to_Speech_Streaming_v1_speech_to_speech__voice_id__stream_post",
"required": [
"audio"
],
"properties": {
"audio": {
"type": "string",
"title": "Audio",
"format": "binary",
"description": "The audio file which holds the content and emotion that will control the generated speech."
},
"model_id": {
"type": "string",
"title": "Model Id",
"default": "eleven_english_sts_v2",
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for speech to speech, you can check this using the can_do_voice_conversion property."
},
"voice_settings": {
"type": "string",
"title": "Voice Settings",
"description": "Voice settings overriding stored setttings for the given voice. They are applied only on the given request. Needs to be send as a JSON encoded string."
}
}
}
Body_Speech_to_Speech_v1_speech_to_speech__voice_id__post
{
"type": "object",
"title": "Body_Speech_to_Speech_v1_speech_to_speech__voice_id__post",
"required": [
"audio"
],
"properties": {
"audio": {
"type": "string",
"title": "Audio",
"format": "binary",
"description": "The audio file which holds the content and emotion that will control the generated speech."
},
"model_id": {
"type": "string",
"title": "Model Id",
"default": "eleven_english_sts_v2",
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for speech to speech, you can check this using the can_do_voice_conversion property."
},
"voice_settings": {
"type": "string",
"title": "Voice Settings",
"description": "Voice settings overriding stored setttings for the given voice. They are applied only on the given request. Needs to be send as a JSON encoded string."
}
}
}
Body_Stream_chapter_audio_v1_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post
{
"type": "object",
"title": "Body_Stream_chapter_audio_v1_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post",
"properties": {
"convert_to_mpeg": {
"type": "boolean",
"title": "Convert To Mpeg",
"default": false,
"description": "Whether to convert the audio to mpeg format."
}
}
}
Body_Stream_project_audio_v1_projects__project_id__snapshots__project_snapshot_id__stream_post
{
"type": "object",
"title": "Body_Stream_project_audio_v1_projects__project_id__snapshots__project_snapshot_id__stream_post",
"properties": {
"convert_to_mpeg": {
"type": "boolean",
"title": "Convert To Mpeg",
"default": false,
"description": "Whether to convert the audio to mpeg format."
}
}
}
Body_Text_to_speech_v1_text_to_speech__voice_id__post
{
"type": "object",
"title": "Body_Text_to_speech_v1_text_to_speech__voice_id__post",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"description": "The text that will get converted into speech."
},
"model_id": {
"type": "string",
"title": "Model Id",
"default": "eleven_monolingual_v1",
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property."
},
"voice_settings": {
"$ref": "#/components/schemas/VoiceSettingsResponseModel"
},
"pronunciation_dictionary_locators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PronunciationDictionaryVersionLocatorDBModel"
},
"title": "Pronunciation Dictionary Locators",
"default": [],
"description": "A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request"
}
},
"x-konfig-properties": {
"voice_settings": {
"title": "Voice Settings",
"description": "Voice settings overriding stored setttings for the given voice. They are applied only on the given request."
}
}
}
Body_Text_to_speech_v1_text_to_speech__voice_id__stream_post
{
"type": "object",
"title": "Body_Text_to_speech_v1_text_to_speech__voice_id__stream_post",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"description": "The text that will get converted into speech."
},
"model_id": {
"type": "string",
"title": "Model Id",
"default": "eleven_monolingual_v1",
"description": "Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property."
},
"voice_settings": {
"$ref": "#/components/schemas/VoiceSettingsResponseModel"
},
"pronunciation_dictionary_locators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PronunciationDictionaryVersionLocatorDBModel"
},
"title": "Pronunciation Dictionary Locators",
"default": [],
"description": "A list of pronunciation dictionary locators (id, version_id) to be applied to the text. They will be applied in order. You may have up to 3 locators per request"
}
},
"x-konfig-properties": {
"voice_settings": {
"title": "Voice Settings",
"description": "Voice settings overriding stored setttings for the given voice. They are applied only on the given request."
}
}
}
Body_Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post
{
"type": "object",
"title": "Body_Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post",
"required": [
"pronunciation_dictionary_locators"
],
"properties": {
"pronunciation_dictionary_locators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PronunciationDictionaryVersionLocatorDBModel"
},
"title": "Pronunciation Dictionary Locators",
"description": "A list of pronunciation dictionary locators (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"
}
}
}
ChapterResponseModel
{
"type": "object",
"title": "ChapterResponseModel",
"required": [
"chapter_id",
"name",
"last_conversion_date_unix",
"conversion_progress",
"can_be_downloaded",
"state",
"statistics"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"state": {
"enum": [
"default",
"converting"
],
"type": "string",
"title": "State"
},
"chapter_id": {
"type": "string",
"title": "Chapter Id"
},
"statistics": {
"$ref": "#/components/schemas/ChapterStatisticsResponseModel"
},
"can_be_downloaded": {
"type": "boolean",
"title": "Can Be Downloaded"
},
"conversion_progress": {
"type": "number",
"title": "Conversion Progress"
},
"last_conversion_date_unix": {
"type": "integer",
"title": "Last Conversion Date Unix"
}
}
}
ChapterSnapshotResponseModel
{
"type": "object",
"title": "ChapterSnapshotResponseModel",
"required": [
"chapter_snapshot_id",
"project_id",
"chapter_id",
"created_at_unix",
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"chapter_id": {
"type": "string",
"title": "Chapter Id"
},
"project_id": {
"type": "string",
"title": "Project Id"
},
"created_at_unix": {
"type": "integer",
"title": "Created At Unix"
},
"chapter_snapshot_id": {
"type": "string",
"title": "Chapter Snapshot Id"
}
}
}
ChapterSnapshotsResponseModel
{
"type": "object",
"title": "ChapterSnapshotsResponseModel",
"required": [
"snapshots"
],
"properties": {
"snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChapterSnapshotResponseModel"
},
"title": "Snapshots"
}
}
}
ChapterStatisticsResponseModel
{
"type": "object",
"title": "ChapterStatisticsResponseModel",
"required": [
"characters_unconverted",
"characters_converted",
"paragraphs_converted",
"paragraphs_unconverted"
],
"properties": {
"characters_converted": {
"type": "integer",
"title": "Characters Converted"
},
"paragraphs_converted": {
"type": "integer",
"title": "Paragraphs Converted"
},
"characters_unconverted": {
"type": "integer",
"title": "Characters Unconverted"
},
"paragraphs_unconverted": {
"type": "integer",
"title": "Paragraphs Unconverted"
}
}
}
DoDubbingResponseModel
{
"type": "object",
"title": "DoDubbingResponseModel",
"required": [
"dubbing_id",
"expected_duration_sec"
],
"properties": {
"dubbing_id": {
"type": "string",
"title": "Dubbing Id"
},
"expected_duration_sec": {
"type": "number",
"title": "Expected Duration Sec"
}
}
}
DubbingDeleteProjectResponse
{
"type": "object",
"example": {},
"properties": {}
}
DubbingMetadataResponse
{
"type": "object",
"title": "DubbingMetadataResponse",
"required": [
"dubbing_id",
"name",
"status",
"error",
"target_languages"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"error": {
"type": "string",
"title": "Error"
},
"status": {
"type": "string",
"title": "Status"
},
"dubbing_id": {
"type": "string",
"title": "Dubbing Id"
},
"target_languages": {
"type": "array",
"items": {
"type": "string"
},
"title": "Target Languages"
}
}
}
ExtendedSubscriptionResponseModel
{
"type": "object",
"title": "ExtendedSubscriptionResponseModel",
"required": [
"tier",
"character_count",
"character_limit",
"can_extend_character_limit",
"allowed_to_extend_character_limit",
"next_character_count_reset_unix",
"voice_limit",
"max_voice_add_edits",
"voice_add_edit_counter",
"professional_voice_limit",
"can_extend_voice_limit",
"can_use_instant_voice_cloning",
"can_use_professional_voice_cloning",
"currency",
"status",
"billing_period",
"next_invoice",
"has_open_invoices"
],
"properties": {
"tier": {
"type": "string",
"title": "Tier"
},
"status": {
"enum": [
"trialing",
"active",
"incomplete",
"incomplete_expired",
"past_due",
"canceled",
"unpaid",
"free"
],
"type": "string",
"title": "Status"
},
"currency": {
"enum": [
"usd",
"eur"
],
"type": "string",
"title": "Currency"
},
"voice_limit": {
"type": "integer",
"title": "Voice Limit"
},
"next_invoice": {
"$ref": "#/components/schemas/InvoiceResponseModel"
},
"billing_period": {
"enum": [
"monthly_period",
"annual_period"
],
"type": "string",
"title": "Billing Period"
},
"character_count": {
"type": "integer",
"title": "Character Count"
},
"character_limit": {
"type": "integer",
"title": "Character Limit"
},
"has_open_invoices": {
"type": "boolean",
"title": "Has Open Invoices"
},
"max_voice_add_edits": {
"type": "integer",
"title": "Max Voice Add Edits"
},
"can_extend_voice_limit": {
"type": "boolean",
"title": "Can Extend Voice Limit"
},
"voice_add_edit_counter": {
"type": "integer",
"title": "Voice Add Edit Counter"
},
"professional_voice_limit": {
"type": "integer",
"title": "Professional Voice Limit"
},
"can_extend_character_limit": {
"type": "boolean",
"title": "Can Extend Character Limit"
},
"can_use_instant_voice_cloning": {
"type": "boolean",
"title": "Can Use Instant Voice Cloning"
},
"next_character_count_reset_unix": {
"type": "integer",
"title": "Next Character Count Reset Unix"
},
"allowed_to_extend_character_limit": {
"type": "boolean",
"title": "Allowed To Extend Character Limit"
},
"can_use_professional_voice_cloning": {
"type": "boolean",
"title": "Can Use Professional Voice Cloning"
}
}
}
FeedbackResponseModel
{
"type": "object",
"title": "FeedbackResponseModel",
"required": [
"thumbs_up",
"feedback",
"emotions",
"inaccurate_clone",
"glitches",
"audio_quality",
"other"
],
"properties": {
"other": {
"type": "boolean",
"title": "Other"
},
"emotions": {
"type": "boolean",
"title": "Emotions"
},
"feedback": {
"type": "string",
"title": "Feedback"
},
"glitches": {
"type": "boolean",
"title": "Glitches"
},
"thumbs_up": {
"type": "boolean",
"title": "Thumbs Up"
},
"audio_quality": {
"type": "boolean",
"title": "Audio Quality"
},
"review_status": {
"type": "string",
"title": "Review Status",
"default": "not_reviewed"
},
"inaccurate_clone": {
"type": "boolean",
"title": "Inaccurate Clone"
}
}
}
FineTuningResponseModel
{
"type": "object",
"title": "FineTuningResponseModel",
"required": [
"is_allowed_to_fine_tune",
"finetuning_state",
"verification_failures",
"verification_attempts_count",
"manual_verification_requested"
],
"properties": {
"message": {
"type": "string",
"title": "Message"
},
"language": {
"type": "string",
"title": "Language"
},
"slice_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Slice Ids"
},
"finetuning_state": {
"enum": [
"not_started",
"queued",
"fine_tuning",
"fine_tuned",
"failed",
"delayed"
],
"type": "string",
"title": "Finetuning State"
},
"finetuning_progress": {
"type": "object",
"title": "Finetuning Progress",
"additionalProperties": {
"type": "number"
}
},
"manual_verification": {
"$ref": "#/components/schemas/ManualVerificationResponseModel"
},
"verification_attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerificationAttemptResponseModel"
},
"title": "Verification Attempts"
},
"verification_failures": {
"type": "array",
"items": {
"type": "string"
},
"title": "Verification Failures"
},
"is_allowed_to_fine_tune": {
"type": "boolean",
"title": "Is Allowed To Fine Tune"
},
"dataset_duration_seconds": {
"type": "number",
"title": "Dataset Duration Seconds"
},
"verification_attempts_count": {
"type": "integer",
"title": "Verification Attempts Count"
},
"manual_verification_requested": {
"type": "boolean",
"title": "Manual Verification Requested"
}
}
}
GetChaptersResponseModel
{
"type": "object",
"title": "GetChaptersResponseModel",
"required": [
"chapters"
],
"properties": {
"chapters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChapterResponseModel"
},
"title": "Chapters"
}
}
}
GetLibraryVoicesResponseModel
{
"type": "object",
"title": "GetLibraryVoicesResponseModel",
"required": [
"voices",
"has_more"
],
"properties": {
"voices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryVoiceResponseModel"
},
"title": "Voices"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"last_sort_id": {
"type": "string",
"title": "Last Sort Id"
}
}
}
GetProjectsResponseModel
{
"type": "object",
"title": "GetProjectsResponseModel",
"required": [
"projects"
],
"properties": {
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectResponseModel"
},
"title": "Projects"
}
}
}
GetPronunciationDictionariesMetadataResponseModel
{
"type": "object",
"title": "GetPronunciationDictionariesMetadataResponseModel",
"required": [
"pronunciation_dictionaries",
"next_cursor",
"has_more"
],
"properties": {
"has_more": {
"type": "boolean",
"title": "Has More"
},
"next_cursor": {
"type": "string",
"title": "Next Cursor"
},
"pronunciation_dictionaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetPronunciationDictionaryMetadataResponseModel"
},
"title": "Pronunciation Dictionaries"
}
}
}
GetPronunciationDictionaryMetadataResponseModel
{
"type": "object",
"title": "GetPronunciationDictionaryMetadataResponseModel",
"required": [
"id",
"latest_version_id",
"name",
"created_by",
"creation_time_unix"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"description": {
"type": "string",
"title": "Description"
},
"latest_version_id": {
"type": "string",
"title": "Latest Version Id"
},
"creation_time_unix": {
"type": "integer",
"title": "Creation Time Unix"
}
}
}
GetSpeechHistoryResponseModel
{
"type": "object",
"title": "GetSpeechHistoryResponseModel",
"required": [
"history",
"last_history_item_id",
"has_more"
],
"properties": {
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SpeechHistoryItemResponseModel"
},
"title": "History"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"last_history_item_id": {
"type": "string",
"title": "Last History Item Id"
}
}
}
GetVoicesResponseModel
{
"type": "object",
"title": "GetVoicesResponseModel",
"required": [
"voices"
],
"properties": {
"voices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceResponseModel"
},
"title": "Voices"
}
}
}
HTTPValidationError
{
"type": "object",
"title": "HTTPValidationError",
"properties": {
"detail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail"
}
}
}
InvoiceResponseModel
{
"type": "object",
"title": "InvoiceResponseModel",
"required": [
"amount_due_cents",
"next_payment_attempt_unix"
],
"properties": {
"amount_due_cents": {
"type": "integer",
"title": "Amount Due Cents"
},
"next_payment_attempt_unix": {
"type": "integer",
"title": "Next Payment Attempt Unix"
}
}
}
LanguageResponseModel
{
"type": "object",
"title": "LanguageResponseModel",
"required": [
"language_id",
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"language_id": {
"type": "string",
"title": "Language Id"
}
}
}
LibraryVoiceResponseModel
{
"type": "object",
"title": "LibraryVoiceResponseModel",
"required": [
"public_owner_id",
"voice_id",
"date_unix",
"name",
"accent",
"gender",
"age",
"descriptive",
"use_case",
"category",
"language",
"description",
"preview_url",
"usage_character_count_1y",
"usage_character_count_7d",
"cloned_by_count",
"rate",
"free_users_allowed",
"live_moderation_enabled",
"featured"
],
"properties": {
"age": {
"type": "string",
"title": "Age"
},
"name": {
"type": "string",
"title": "Name"
},
"rate": {
"type": "number",
"title": "Rate"
},
"accent": {
"type": "string",
"title": "Accent"
},
"gender": {
"type": "string",
"title": "Gender"
},
"category": {
"type": "string",
"title": "Category"
},
"featured": {
"type": "boolean",
"title": "Featured"
},
"language": {
"type": "string",
"title": "Language"
},
"use_case": {
"type": "string",
"title": "Use Case"
},
"voice_id": {
"type": "string",
"title": "Voice Id"
},
"date_unix": {
"type": "integer",
"title": "Date Unix"
},
"description": {
"type": "string",
"title": "Description"
},
"descriptive": {
"type": "string",
"title": "Descriptive"
},
"preview_url": {
"type": "string",
"title": "Preview Url"
},
"notice_period": {
"type": "integer",
"title": "Notice Period"
},
"cloned_by_count": {
"type": "integer",
"title": "Cloned By Count"
},
"public_owner_id": {
"type": "string",
"title": "Public Owner Id"
},
"tiktok_username": {
"type": "string",
"title": "Tiktok Username"
},
"twitter_username": {
"type": "string",
"title": "Twitter Username"
},
"youtube_username": {
"type": "string",
"title": "Youtube Username"
},
"free_users_allowed": {
"type": "boolean",
"title": "Free Users Allowed"
},
"instagram_username": {
"type": "string",
"title": "Instagram Username"
},
"live_moderation_enabled": {
"type": "boolean",
"title": "Live Moderation Enabled"
},
"usage_character_count_1y": {
"type": "integer",
"title": "Usage Character Count 1Y"
},
"usage_character_count_7d": {
"type": "integer",
"title": "Usage Character Count 7D"
}
}
}
ManualVerificationFileResponseModel
{
"type": "object",
"title": "ManualVerificationFileResponseModel",
"required": [
"file_id",
"file_name",
"mime_type",
"size_bytes",
"upload_date_unix"
],
"properties": {
"file_id": {
"type": "string",
"title": "File Id"
},
"file_name": {
"type": "string",
"title": "File Name"
},
"mime_type": {
"type": "string",
"title": "Mime Type"
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes"
},
"upload_date_unix": {
"type": "integer",
"title": "Upload Date Unix"
}
}
}
ManualVerificationResponseModel
{
"type": "object",
"title": "ManualVerificationResponseModel",
"required": [
"extra_text",
"request_time_unix",
"files"
],
"properties": {
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualVerificationFileResponseModel"
},
"title": "Files"
},
"extra_text": {
"type": "string",
"title": "Extra Text"
},
"request_time_unix": {
"type": "integer",
"title": "Request Time Unix"
}
}
}
ModelResponseModel
{
"type": "object",
"title": "ModelResponseModel",
"required": [
"model_id",
"name",
"can_be_finetuned",
"can_do_text_to_speech",
"can_do_voice_conversion",
"can_use_style",
"can_use_speaker_boost",
"serves_pro_voices",
"token_cost_factor",
"description",
"requires_alpha_access",
"max_characters_request_free_user",
"max_characters_request_subscribed_user",
"languages"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"model_id": {
"type": "string",
"title": "Model Id"
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageResponseModel"
},
"title": "Languages"
},
"description": {
"type": "string",
"title": "Description"
},
"can_use_style": {
"type": "boolean",
"title": "Can Use Style"
},
"can_be_finetuned": {
"type": "boolean",
"title": "Can Be Finetuned"
},
"serves_pro_voices": {
"type": "boolean",
"title": "Serves Pro Voices"
},
"token_cost_factor": {
"type": "number",
"title": "Token Cost Factor"
},
"can_do_text_to_speech": {
"type": "boolean",
"title": "Can Do Text To Speech"
},
"can_use_speaker_boost": {
"type": "boolean",
"title": "Can Use Speaker Boost"
},
"requires_alpha_access": {
"type": "boolean",
"title": "Requires Alpha Access"
},
"can_do_voice_conversion": {
"type": "boolean",
"title": "Can Do Voice Conversion"
},
"max_characters_request_free_user": {
"type": "integer",
"title": "Max Characters Request Free User"
},
"max_characters_request_subscribed_user": {
"type": "integer",
"title": "Max Characters Request Subscribed User"
}
}
}
ModelsListAvailableModelsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelResponseModel"
},
"title": "Response Get Models V1 Models Get"
}
ProjectExtendedResponseModel
{
"type": "object",
"title": "ProjectExtendedResponseModel",
"required": [
"project_id",
"name",
"create_date_unix",
"default_title_voice_id",
"default_paragraph_voice_id",
"default_model_id",
"last_conversion_date_unix",
"can_be_downloaded",
"state",
"chapters"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"state": {
"enum": [
"default",
"converting",
"in_queue"
],
"type": "string",
"title": "State"
},
"chapters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChapterResponseModel"
},
"title": "Chapters"
},
"project_id": {
"type": "string",
"title": "Project Id"
},
"create_date_unix": {
"type": "integer",
"title": "Create Date Unix"
},
"default_model_id": {
"type": "string",
"title": "Default Model Id"
},
"can_be_downloaded": {
"type": "boolean",
"title": "Can Be Downloaded"
},
"default_title_voice_id": {
"type": "string",
"title": "Default Title Voice Id"
},
"last_conversion_date_unix": {
"type": "integer",
"title": "Last Conversion Date Unix"
},
"default_paragraph_voice_id": {
"type": "string",
"title": "Default Paragraph Voice Id"
}
}
}
ProjectResponseModel
{
"type": "object",
"title": "ProjectResponseModel",
"required": [
"project_id",
"name",
"create_date_unix",
"default_title_voice_id",
"default_paragraph_voice_id",
"default_model_id",
"last_conversion_date_unix",
"can_be_downloaded",
"title",
"author",
"isbn_number",
"volume_normalization",
"state"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"state": {
"enum": [
"default",
"converting"
],
"type": "string",
"title": "State"
},
"title": {
"type": "string",
"title": "Title"
},
"author": {
"type": "string",
"title": "Author"
},
"project_id": {
"type": "string",
"title": "Project Id"
},
"isbn_number": {
"type": "string",
"title": "Isbn Number"
},
"create_date_unix": {
"type": "integer",
"title": "Create Date Unix"
},
"default_model_id": {
"type": "string",
"title": "Default Model Id"
},
"can_be_downloaded": {
"type": "boolean",
"title": "Can Be Downloaded"
},
"volume_normalization": {
"type": "boolean",
"title": "Volume Normalization"
},
"default_title_voice_id": {
"type": "string",
"title": "Default Title Voice Id"
},
"last_conversion_date_unix": {
"type": "integer",
"title": "Last Conversion Date Unix"
},
"default_paragraph_voice_id": {
"type": "string",
"title": "Default Paragraph Voice Id"
}
}
}
ProjectSnapshotResponseModel
{
"type": "object",
"title": "ProjectSnapshotResponseModel",
"required": [
"project_snapshot_id",
"project_id",
"created_at_unix",
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"project_id": {
"type": "string",
"title": "Project Id"
},
"created_at_unix": {
"type": "integer",
"title": "Created At Unix"
},
"project_snapshot_id": {
"type": "string",
"title": "Project Snapshot Id"
}
}
}
ProjectSnapshotsResponseModel
{
"type": "object",
"title": "ProjectSnapshotsResponseModel",
"required": [
"snapshots"
],
"properties": {
"snapshots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectSnapshotResponseModel"
},
"title": "Snapshots"
}
}
}
ProjectsDeleteByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}
ProjectsDeleteChapterByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}
ProjectsStartChapterConversionResponse
{
"type": "object",
"example": {},
"properties": {}
}
ProjectsStartConversionResponse
{
"type": "object",
"example": {},
"properties": {}
}
ProjectsUpdatePronunciationDictionariesResponse
{
"type": "object",
"example": {},
"properties": {}
}
PronunciationDictionaryAliasRuleRequestModel
{
"type": "object",
"title": "PronunciationDictionaryAliasRuleRequestModel",
"required": [
"type",
"string_to_replace",
"alias"
],
"properties": {
"type": {
"enum": [
"alias"
],
"type": "string",
"title": "Type"
},
"alias": {
"type": "string",
"title": "Alias"
},
"string_to_replace": {
"type": "string",
"title": "String To Replace"
}
}
}
PronunciationDictionaryPhonemeRuleRequestModel
{
"type": "object",
"title": "PronunciationDictionaryPhonemeRuleRequestModel",
"required": [
"type",
"string_to_replace",
"phoneme",
"alphabet"
],
"properties": {
"type": {
"enum": [
"phoneme"
],
"type": "string",
"title": "Type"
},
"phoneme": {
"type": "string",
"title": "Phoneme"
},
"alphabet": {
"type": "string",
"title": "Alphabet"
},
"string_to_replace": {
"type": "string",
"title": "String To Replace"
}
}
}
PronunciationDictionaryVersionDownloadResponse
{
"type": "object",
"example": {},
"properties": {}
}
PronunciationDictionaryVersionLocatorDBModel
{
"type": "object",
"title": "PronunciationDictionaryVersionLocatorDBModel",
"required": [
"pronunciation_dictionary_id",
"version_id"
],
"properties": {
"version_id": {
"type": "string",
"title": "Version Id"
},
"pronunciation_dictionary_id": {
"type": "string",
"title": "Pronunciation Dictionary Id"
}
}
}
RecordingResponseModel
{
"type": "object",
"title": "RecordingResponseModel",
"required": [
"recording_id",
"mime_type",
"size_bytes",
"upload_date_unix",
"transcription"
],
"properties": {
"mime_type": {
"type": "string",
"title": "Mime Type"
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes"
},
"recording_id": {
"type": "string",
"title": "Recording Id"
},
"transcription": {
"type": "string",
"title": "Transcription"
},
"upload_date_unix": {
"type": "integer",
"title": "Upload Date Unix"
}
}
}
RedirectToMintlifyDocsGetResponse
{
"type": "object",
"example": {},
"properties": {}
}
RemovePronunciationDictionaryRulesResponseModel
{
"type": "object",
"title": "RemovePronunciationDictionaryRulesResponseModel",
"required": [
"id",
"version_id"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"version_id": {
"type": "string",
"title": "Version Id"
}
}
}
SampleResponseModel
{
"type": "object",
"title": "SampleResponseModel",
"required": [
"sample_id",
"file_name",
"mime_type",
"size_bytes",
"hash"
],
"properties": {
"hash": {
"type": "string",
"title": "Hash"
},
"file_name": {
"type": "string",
"title": "File Name"
},
"mime_type": {
"type": "string",
"title": "Mime Type"
},
"sample_id": {
"type": "string",
"title": "Sample Id"
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes"
}
}
}
SamplesRemoveByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}
SpeechHistoryItemResponseModel
{
"type": "object",
"title": "SpeechHistoryItemResponseModel",
"required": [
"history_item_id",
"request_id",
"voice_id",
"model_id",
"voice_name",
"voice_category",
"text",
"date_unix",
"character_count_change_from",
"character_count_change_to",
"content_type",
"state",
"settings",
"feedback",
"share_link_id",
"source"
],
"properties": {
"text": {
"type": "string",
"title": "Text"
},
"state": {
"enum": [
"created",
"deleted",
"processing"
],
"type": "string",
"title": "State"
},
"source": {
"enum": [
"TTS",
"STS"
],
"type": "string",
"title": "Source"
},
"feedback": {
"$ref": "#/components/schemas/FeedbackResponseModel"
},
"model_id": {
"type": "string",
"title": "Model Id"
},
"settings": {
"type": "object",
"title": "Settings"
},
"voice_id": {
"type": "string",
"title": "Voice Id"
},
"date_unix": {
"type": "integer",
"title": "Date Unix"
},
"request_id": {
"type": "string",
"title": "Request Id"
},
"voice_name": {
"type": "string",
"title": "Voice Name"
},
"content_type": {
"type": "string",
"title": "Content Type"
},
"share_link_id": {
"type": "string",
"title": "Share Link Id"
},
"voice_category": {
"enum": [
"premade",
"cloned",
"generated",
"professional"
],
"type": "string",
"title": "Voice Category"
},
"history_item_id": {
"type": "string",
"title": "History Item Id"
},
"character_count_change_to": {
"type": "integer",
"title": "Character Count Change To"
},
"character_count_change_from": {
"type": "integer",
"title": "Character Count Change From"
}
}
}
SpeechhistoryDeleteHistoryItemByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}
SsoProviderDBModel
{
"type": "object",
"title": "SsoProviderDBModel",
"required": [
"provider_type",
"provider_id",
"domains"
],
"properties": {
"domains": {
"type": "array",
"items": {
"type": "string"
},
"title": "Domains"
},
"provider_id": {
"type": "string",
"title": "Provider Id"
},
"provider_type": {
"enum": [
"saml",
"oidc"
],
"type": "string",
"title": "Provider Type"
}
}
}
SubscriptionResponseModel
{
"type": "object",
"title": "SubscriptionResponseModel",
"required": [
"tier",
"character_count",
"character_limit",
"can_extend_character_limit",
"allowed_to_extend_character_limit",
"next_character_count_reset_unix",
"voice_limit",
"max_voice_add_edits",
"voice_add_edit_counter",
"professional_voice_limit",
"can_extend_voice_limit",
"can_use_instant_voice_cloning",
"can_use_professional_voice_cloning",
"currency",
"status",
"billing_period"
],
"properties": {
"tier": {
"type": "string",
"title": "Tier"
},
"status": {
"enum": [
"trialing",
"active",
"incomplete",
"incomplete_expired",
"past_due",
"canceled",
"unpaid",
"free"
],
"type": "string",
"title": "Status"
},
"currency": {
"enum": [
"usd",
"eur"
],
"type": "string",
"title": "Currency"
},
"voice_limit": {
"type": "integer",
"title": "Voice Limit"
},
"billing_period": {
"enum": [
"monthly_period",
"annual_period"
],
"type": "string",
"title": "Billing Period"
},
"character_count": {
"type": "integer",
"title": "Character Count"
},
"character_limit": {
"type": "integer",
"title": "Character Limit"
},
"max_voice_add_edits": {
"type": "integer",
"title": "Max Voice Add Edits"
},
"can_extend_voice_limit": {
"type": "boolean",
"title": "Can Extend Voice Limit"
},
"voice_add_edit_counter": {
"type": "integer",
"title": "Voice Add Edit Counter"
},
"professional_voice_limit": {
"type": "integer",
"title": "Professional Voice Limit"
},
"can_extend_character_limit": {
"type": "boolean",
"title": "Can Extend Character Limit"
},
"can_use_instant_voice_cloning": {
"type": "boolean",
"title": "Can Use Instant Voice Cloning"
},
"next_character_count_reset_unix": {
"type": "integer",
"title": "Next Character Count Reset Unix"
},
"allowed_to_extend_character_limit": {
"type": "boolean",
"title": "Allowed To Extend Character Limit"
},
"can_use_professional_voice_cloning": {
"type": "boolean",
"title": "Can Use Professional Voice Cloning"
}
}
}
UserResponseModel
{
"type": "object",
"title": "UserResponseModel",
"required": [
"subscription",
"is_new_user",
"xi_api_key",
"can_use_delayed_payment_methods",
"is_onboarding_completed"
],
"properties": {
"first_name": {
"type": "string",
"title": "First Name"
},
"xi_api_key": {
"type": "string",
"title": "Xi Api Key"
},
"is_new_user": {
"type": "boolean",
"title": "Is New User"
},
"subscription": {
"$ref": "#/components/schemas/SubscriptionResponseModel"
},
"is_onboarding_completed": {
"type": "boolean",
"title": "Is Onboarding Completed"
},
"can_use_delayed_payment_methods": {
"type": "boolean",
"title": "Can Use Delayed Payment Methods"
}
}
}
ValidationError
{
"type": "object",
"title": "ValidationError",
"required": [
"loc",
"msg",
"type"
],
"properties": {
"loc": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
}
}
VerificationAttemptResponseModel
{
"type": "object",
"title": "VerificationAttemptResponseModel",
"required": [
"text",
"date_unix",
"accepted",
"similarity",
"levenshtein_distance"
],
"properties": {
"text": {
"type": "string",
"title": "Text"
},
"accepted": {
"type": "boolean",
"title": "Accepted"
},
"date_unix": {
"type": "integer",
"title": "Date Unix"
},
"recording": {
"$ref": "#/components/schemas/RecordingResponseModel"
},
"similarity": {
"type": "number",
"title": "Similarity"
},
"levenshtein_distance": {
"type": "number",
"title": "Levenshtein Distance"
}
}
}
VoiceGenerationParameterOptionResponseModel
{
"type": "object",
"title": "VoiceGenerationParameterOptionResponseModel",
"required": [
"name",
"code"
],
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"name": {
"type": "string",
"title": "Name"
}
}
}
VoiceGenerationParameterResponseModel
{
"type": "object",
"title": "VoiceGenerationParameterResponseModel",
"required": [
"genders",
"accents",
"ages",
"minimum_characters",
"maximum_characters",
"minimum_accent_strength",
"maximum_accent_strength"
],
"properties": {
"ages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceGenerationParameterOptionResponseModel"
},
"title": "Ages"
},
"accents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceGenerationParameterOptionResponseModel"
},
"title": "Accents"
},
"genders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoiceGenerationParameterOptionResponseModel"
},
"title": "Genders"
},
"maximum_characters": {
"type": "integer",
"title": "Maximum Characters"
},
"minimum_characters": {
"type": "integer",
"title": "Minimum Characters"
},
"maximum_accent_strength": {
"type": "number",
"title": "Maximum Accent Strength"
},
"minimum_accent_strength": {
"type": "number",
"title": "Minimum Accent Strength"
}
}
}
VoiceResponseModel
{
"type": "object",
"title": "VoiceResponseModel",
"required": [
"voice_id",
"name",
"samples",
"category",
"fine_tuning",
"labels",
"description",
"preview_url",
"available_for_tiers",
"settings",
"sharing",
"high_quality_base_model_ids"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"labels": {
"type": "object",
"title": "Labels",
"additionalProperties": {
"type": "string"
}
},
"samples": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SampleResponseModel"
},
"title": "Samples"
},
"sharing": {
"$ref": "#/components/schemas/VoiceSharingResponseModel"
},
"category": {
"type": "string",
"title": "Category"
},
"owner_id": {
"type": "string",
"title": "Owner Id"
},
"settings": {
"$ref": "#/components/schemas/VoiceSettingsResponseModel"
},
"voice_id": {
"type": "string",
"title": "Voice Id"
},
"description": {
"type": "string",
"title": "Description"
},
"fine_tuning": {
"$ref": "#/components/schemas/FineTuningResponseModel"
},
"preview_url": {
"type": "string",
"title": "Preview Url"
},
"safety_control": {
"enum": [
"NONE",
"BAN",
"CAPTCHA",
"CAPTCHA_AND_MODERATION"
],
"type": "string",
"title": "Safety Control"
},
"voice_verification": {
"$ref": "#/components/schemas/VoiceVerificationResponseModel"
},
"available_for_tiers": {
"type": "array",
"items": {
"type": "string"
},
"title": "Available For Tiers"
},
"permission_on_resource": {
"type": "string",
"title": "Permission On Resource"
},
"high_quality_base_model_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "High Quality Base Model Ids"
}
}
}
VoiceSettingsResponseModel
{
"type": "object",
"title": "VoiceSettingsResponseModel",
"required": [
"stability",
"similarity_boost"
],
"properties": {
"style": {
"type": "number",
"title": "Style",
"default": 0
},
"stability": {
"type": "number",
"title": "Stability"
},
"similarity_boost": {
"type": "number",
"title": "Similarity Boost"
},
"use_speaker_boost": {
"type": "boolean",
"title": "Use Speaker Boost",
"default": true
}
}
}
VoiceSharingResponseModel
{
"type": "object",
"title": "VoiceSharingResponseModel",
"required": [
"status",
"history_item_sample_id",
"date_unix",
"whitelisted_emails",
"public_owner_id",
"original_voice_id",
"financial_rewards_enabled",
"free_users_allowed",
"live_moderation_enabled",
"rate",
"notice_period",
"disable_at_unix",
"voice_mixing_allowed",
"featured",
"category",
"reader_app_enabled",
"ban_reason",
"liked_by_count",
"cloned_by_count",
"name",
"description",
"labels",
"review_status",
"review_message",
"enabled_in_library"
],
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"rate": {
"type": "number",
"title": "Rate"
},
"labels": {
"type": "object",
"title": "Labels",
"additionalProperties": {
"type": "string"
}
},
"status": {
"enum": [
"enabled",
"disabled",
"copied",
"copied_disabled"
],
"type": "string",
"title": "Status"
},
"category": {
"enum": [
"generated",
"professional",
"high_quality"
],
"type": "string",
"title": "Category"
},
"featured": {
"type": "boolean",
"title": "Featured"
},
"date_unix": {
"type": "integer",
"title": "Date Unix"
},
"ban_reason": {
"type": "string",
"title": "Ban Reason"
},
"description": {
"type": "string",
"title": "Description"
},
"notice_period": {
"type": "integer",
"title": "Notice Period"
},
"review_status": {
"enum": [
"not_requested",
"pending",
"declined",
"allowed",
"allowed_with_changes"
],
"type": "string",
"title": "Review Status"
},
"liked_by_count": {
"type": "integer",
"title": "Liked By Count"
},
"review_message": {
"type": "string",
"title": "Review Message"
},
"cloned_by_count": {
"type": "integer",
"title": "Cloned By Count"
},
"disable_at_unix": {
"type": "integer",
"title": "Disable At Unix"
},
"public_owner_id": {
"type": "string",
"title": "Public Owner Id"
},
"tiktok_username": {
"type": "string",
"title": "Tiktok Username"
},
"twitter_username": {
"type": "string",
"title": "Twitter Username"
},
"youtube_username": {
"type": "string",
"title": "Youtube Username"
},
"original_voice_id": {
"type": "string",
"title": "Original Voice Id"
},
"enabled_in_library": {
"type": "boolean",
"title": "Enabled In Library"
},
"free_users_allowed": {
"type": "boolean",
"title": "Free Users Allowed"
},
"instagram_username": {
"type": "string",
"title": "Instagram Username"
},
"reader_app_enabled": {
"type": "boolean",
"title": "Reader App Enabled"
},
"whitelisted_emails": {
"type": "array",
"items": {
"type": "string"
},
"title": "Whitelisted Emails"
},
"voice_mixing_allowed": {
"type": "boolean",
"title": "Voice Mixing Allowed"
},
"history_item_sample_id": {
"type": "string",
"title": "History Item Sample Id"
},
"live_moderation_enabled": {
"type": "boolean",
"title": "Live Moderation Enabled"
},
"financial_rewards_enabled": {
"type": "boolean",
"title": "Financial Rewards Enabled"
}
}
}
VoiceVerificationResponseModel
{
"type": "object",
"title": "VoiceVerificationResponseModel",
"required": [
"requires_verification",
"is_verified",
"verification_failures",
"verification_attempts_count"
],
"properties": {
"language": {
"type": "string",
"title": "Language"
},
"is_verified": {
"type": "boolean",
"title": "Is Verified"
},
"requires_verification": {
"type": "boolean",
"title": "Requires Verification"
},
"verification_attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerificationAttemptResponseModel"
},
"title": "Verification Attempts"
},
"verification_failures": {
"type": "array",
"items": {
"type": "string"
},
"title": "Verification Failures"
},
"verification_attempts_count": {
"type": "integer",
"title": "Verification Attempts Count"
}
}
}
VoicesDeleteByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}
VoicesEditSettingsPostResponse
{
"type": "object",
"example": {},
"properties": {}
}
VoicesUpdateVoiceByIdResponse
{
"type": "object",
"example": {},
"properties": {}
}