{"openapi":"3.0.0","info":{"description":"Text-to-speech and voice cloning platform with natural-sounding AI voices","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Text-to-speech and voice cloning platform with natural-sounding AI voices","url":"https://api.apirails.com/elevenlabs"}],"paths":{"/v1/audio-native":{"post":{"tags":["Audio-native"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/creates-audionative-enabled-project","api_endpoint":"https://api.elevenlabs.io/v1/audio-native"},"summary":"Creates Audionative Enabled Project.","description":"Creates AudioNative enabled project, optionally starts conversion and returns project id and embeddable html snippet.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"author":{"type":"string","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."},"auto_convert":{"type":"boolean","description":"Whether to auto convert the project to audio or not.","enum":[true,false]},"background_color":{"type":"string","description":"Background color used in the player. If not provided, default background color set in the Player settings is used."},"file":{"type":"string","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>'"},"image":{"type":"string","description":"Image URL used in the player. If not provided, default image set in the Player settings is used."},"model_id":{"type":"string","description":"TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used."},"name":{"type":"string","description":"Project name.","required":true},"sessionization":{"type":"number","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."},"small":{"type":"boolean","description":"Whether to use small player or not. If not provided, default value set in the Player settings is used.","enum":[true,false]},"text_color":{"type":"string","description":"Text color used in the player. If not provided, default text color set in the Player settings is used."},"title":{"type":"string","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."},"voice_id":{"type":"string","description":"Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used."}}},"example":{"author":"","auto_convert":"","background_color":"","file":"","image":"","model_id":"","name":"","sessionization":"","small":"","text_color":"","title":"","voice_id":""}}}}}},"/v1/dubbing":{"post":{"tags":["Dubbing"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/create-dub","api_endpoint":"https://api.elevenlabs.io/v1/dubbing"},"summary":"Dub A Video Or An Audio File","description":"Dubs provided audio or video file into given language.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"background_audio_file":{"type":"boolean","description":"For use only with csv input","enum":[true,false]},"csv_file":{"type":"string","description":"CSV file containing transcription/translation metadata"},"dubbing_studio":{"type":"boolean","description":"Whether to prepare dub for edits in dubbing studio.","enum":[true,false]},"end_time":{"type":"number","description":"End time of the source video/audio file."},"file":{"type":"string","description":"A list of file paths to audio recordings intended for voice cloning"},"foreground_audio_file":{"type":"string","description":"For use only with csv input"},"highest_resolution":{"type":"boolean","description":"Whether to use the highest resolution available.","enum":[true,false]},"mode":{"type":"string","description":"automatic or manual. Manual mode is only supported when creating a dubbing studio project"},"name":{"type":"string","description":"Name of the dubbing project."},"num_speakers":{"type":"number","description":"Number of speakers to use for the dubbing. Set to 0 to automatically detect the number of speakers"},"source_lang":{"type":"number","description":"Source language."},"source_url":{"type":"string","description":"URL of the source video/audio file."},"start_time":{"type":"number","description":"Start time of the source video/audio file."},"target_lang":{"type":"string","description":"The Target language to dub the content into. Can be none if dubbing studio editor is enabled and running manual mode"},"watermark":{"type":"boolean","description":"Whether to apply watermark to the output video.","enum":[true,false]}}},"example":{"background_audio_file":"","csv_file":"","dubbing_studio":"","end_time":"","file":"","foreground_audio_file":"","highest_resolution":"","mode":"","name":"","num_speakers":"","source_lang":"","source_url":"","start_time":"","target_lang":"","watermark":""}}}}}},"/v1/dubbing/{dubbing_id}":{"get":{"tags":["Dubbing"],"parameters":[{"name":"dubbing_id","in":"path","description":"ID of the dubbing project.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-dubbing-metadata","api_endpoint":"https://api.elevenlabs.io/v1/dubbing/{dubbing_id}"},"summary":"Get Dubbing Project Metadata","description":"Returns metadata about a dubbing project, including whether it’s still in progress or not","security":[{"bearerAuth":[]}]},"delete":{"tags":["Dubbing"],"parameters":[{"name":"dubbing_id","in":"path","description":"ID of the dubbing project.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-dub","api_endpoint":"https://api.elevenlabs.io/v1/dubbing/{dubbing_id}"},"summary":"Delete Dubbing Project","description":"Deletes a dubbing project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/dubbing/{dubbing_id}/audio/{language_code}":{"get":{"tags":["Dubbing"],"parameters":[{"name":"dubbing_id","in":"path","description":"ID of the dubbing project.","required":true,"schema":{"type":"string","example":""}},{"name":"language_code","in":"path","description":"ID of the language.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-dubbed-file","api_endpoint":"https://api.elevenlabs.io/v1/dubbing/{dubbing_id}/audio/{language_code}"},"summary":"Get Dubbed File","description":"Returns dubbed file as a streamed file. Videos will be returned in MP4 format and audio only dubs will be returned in MP3.","security":[{"bearerAuth":[]}]}},"/v1/history":{"get":{"tags":["History"],"parameters":[{"name":"page_size","in":"query","description":"How many history items to return at maximum","schema":{"type":"number","example":""}},{"name":"start_after_history_item_id","in":"query","description":"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.","schema":{"type":"string","example":""}},{"name":"voice_id","in":"query","description":"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","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-generated-items","api_endpoint":"https://api.elevenlabs.io/v1/history"},"summary":"Get Generated Items","description":"Returns metadata about all your generated audio.","security":[{"bearerAuth":[]}]}},"/v1/history/{history_item_id}":{"get":{"tags":["History"],"parameters":[{"name":"history_item_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-history-item-by-id","api_endpoint":"https://api.elevenlabs.io/v1/history/{history_item_id}"},"summary":"Get History Item By Id","description":"Returns information about an history item by its ID.","security":[{"bearerAuth":[]}]},"delete":{"tags":["History"],"parameters":[{"name":"history_item_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-history-item","api_endpoint":"https://api.elevenlabs.io/v1/history/{history_item_id}"},"summary":"Delete History Item","description":"Delete a history item by its ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/history/{history_item_id}/audio":{"get":{"tags":["History"],"parameters":[{"name":"history_item_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-audio-from-history-item","api_endpoint":"https://api.elevenlabs.io/v1/history/{history_item_id}/audio"},"summary":"Get Audio From History Item","description":"Returns the audio of an history item.","security":[{"bearerAuth":[]}]}},"/v1/models":{"get":{"tags":["Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-models","api_endpoint":"https://api.elevenlabs.io/v1/models"},"summary":"Get Models","description":"Gets a list of available models.","security":[{"bearerAuth":[]}]}},"/v1/projects":{"get":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-projects","api_endpoint":"https://api.elevenlabs.io/v1/projects"},"summary":"Get Projects","description":"Returns a list of your projects together and its metadata.","security":[{"bearerAuth":[]}]}},"/v1/history/download":{"post":{"tags":["History"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/download-history-items","api_endpoint":"https://api.elevenlabs.io/v1/history/download"},"summary":"Download History Items","description":"Download one or more history items. If one history item ID is provided, we will return a single audio file. If more than one history item IDs are provided, we will provide the history items packed into a .zip file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"history_item_id":{"type":"string","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.","required":true},"output_format":{"type":"string","description":"Output format to transcode the audio file, can be wav or default."}}},"example":{"history_item_id":"","output_format":""}}}}}},"/v1/projects/{project_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-project-by-id","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}"},"summary":"Get Projects By Id","description":"Returns information about a specific project","security":[{"bearerAuth":[]}]},"delete":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-project","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}"},"summary":"Delete Project","description":"Delete a project by its project_id.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/projects/{project_id}/snapshots":{"get":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-project-snapshots","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/snapshots"},"summary":"Get Project Snapshots","description":"Gets the snapshots of a project.","security":[{"bearerAuth":[]}]}},"/v1/projects/{project_id}/convert":{"post":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/convert-project","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/convert"},"summary":"Convert Project","description":"Starts conversion of a project and all of its chapters","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/projects/add":{"post":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/add-project","api_endpoint":"https://api.elevenlabs.io/v1/projects/add"},"summary":"Add Project","description":"Creates a new project, it can be either initialized as blank, from a document or from a URL.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"acx_volume_normalization":{"type":"boolean","description":"When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements","enum":[true,false]},"author":{"type":"string","description":"An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."},"callback_url":{"type":"string","description":"A url that will be called by our service when the project is converted with a json containing the status of the conversion"},"default_model_id":{"type":"string","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.","required":true},"default_paragraph_voice_id":{"type":"string","description":"The voice_id that corresponds to the default voice used for new paragraph","required":true},"default_title_voice_id":{"type":"string","description":"The voice_id that corresponds to the default voice used for new titles","required":true},"from_document":{"type":"string","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."},"from_url":{"type":"string","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","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."},"name":{"type":"string","description":"The name of the project, used for identification only.","required":true},"pronunciation_dictionary_locators":{"type":"string","description":"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."},"quality_preset":{"type":"string","description":"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 character 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 character 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 character cost by 100%."},"title":{"type":"string","description":"An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."},"volume_normalization":{"type":"boolean","description":"When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements","enum":[true,false]}}},"example":{"acx_volume_normalization":"","author":"","callback_url":"","default_model_id":"","default_paragraph_voice_id":"","default_title_voice_id":"","from_document":"","from_url":"","isbn_number":"","name":"","pronunciation_dictionary_locators":"","quality_preset":"","title":"","volume_normalization":""}}}}}},"/v1/projects/{project_id}/chapters":{"get":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-chapters","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters"},"summary":"Get Chapters","description":"Returns a list of your chapters for a project together and its metadata","security":[{"bearerAuth":[]}]}},"/v1/projects/{project_id}/snapshots/{project_snapshot_id}/stream":{"post":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}},{"name":"project_snapshot_id","in":"path","description":"The project_snapshot_id of the project snapshot. You can query GET /v1/projects/{project_id}/snapshots to list all available snapshots for a project.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/stream-project-audio","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/snapshots/{project_snapshot_id}/stream"},"summary":"Stream Project Audio","description":"Stream the audio from a project snapshot.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"convert_to_mpeg":{"type":"boolean","description":"Whether to convert the audio to mpeg format.","enum":[true,false]}}},"example":{"convert_to_mpeg":""}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"chapter_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-chapter-by-id","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters/{chapter_id}"},"summary":"Get Chapters By Id","description":"Returns information about a specific chapter.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Projects"],"parameters":[{"name":"chapter_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-chapter","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters/{chapter_id}"},"summary":"Delete Chapters","description":"Delete a chapter by its chapter_id.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}/convert":{"post":{"tags":["Projects"],"parameters":[{"name":"chapter_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/convert-chapter","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters/{chapter_id}/convert"},"summary":"Convert Chapters","description":"Starts conversion of a specific chapter.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}/snapshots":{"get":{"tags":["Projects"],"parameters":[{"name":"chapter_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-chapter-snapshots","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters/{chapter_id}/snapshots"},"summary":"Get Chapter Snapshorts","description":"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.","security":[{"bearerAuth":[]}]}},"/v1/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream":{"post":{"tags":["Projects"],"parameters":[{"name":"chapter_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"chapter_snapshot_id","in":"path","description":"The chapter_snapshot_id of the chapter snapshot. You can query GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots to the all available snapshots for a chapter.","required":true,"schema":{"type":"string","example":""}},{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/stream-chapter-audio","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream"},"summary":"Stream Chapter Audio","description":"Stream the audio from a chapter snapshot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"convert_to_mpeg":{"type":"boolean","description":"Whether to convert the audio to mpeg format.","enum":[true,false]}}},"example":{"convert_to_mpeg":""}}}}}},"/v1/pronunciation-dictionaries/add-from-file":{"post":{"tags":["Pronunciation Dictionaries"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-add-from-file","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/add-from-file"},"summary":"Add from file","description":"Creates a new pronunciation dictionary from a lexicon .PLS file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the pronunciation dictionary, used for identification only."},"file":{"type":"string","description":"A lexicon .pls file which we will use to initialize the project with."},"name":{"type":"string","description":"The name of the pronunciation dictionary, used for identification only.","required":true},"workspace_access":{"type":"enum","description":"Should be one of 'editor' or 'viewer'. If not provided, defaults to no access.","enum":["admin","editor","viewer"]}}},"example":{"description":"","file":"","name":"","workspace_access":""}}}}}},"/v1/projects/{project_id}/update-pronunciation-dictionaries":{"post":{"tags":["Projects"],"parameters":[{"name":"project_id","in":"path","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/update-pronunciation-dictionaries","api_endpoint":"https://api.elevenlabs.io/v1/projects/{project_id}/update-pronunciation-dictionaries"},"summary":"Update Pronunciation Dictionaries","description":"Updates the set of pronunciation dictionaries acting on a project. This will automatically mark text within this project as requiring reconverting where the new dictionary would apply or the old one no longer does.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pronunciation_dictionary_locators":{"type":"boolean","description":"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","required":true,"enum":[true,false]}}},"example":{"pronunciation_dictionary_locators":""}}}}}},"/v1/pronunciation-dictionaries":{"get":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"cursor","in":"query","description":"Used for fetching next page. Cursor is returned in the response","schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-list","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries"},"summary":"Get dictionaries","description":"Get a list of the pronunciation dictionaries you have access to and their metadata","security":[{"bearerAuth":[]}]}},"/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}":{"get":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"pronunciation_dictionary_id","in":"path","description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-id","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}"},"summary":"Get dictionaries by id","description":"Get metadata for a pronunciation dictionary","security":[{"bearerAuth":[]}]},"patch":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"pronunciation_dictionary_id","in":"path","description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-update","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}"},"summary":"Update Pronunciation Dictionary","description":"Updates metadata for a pronunciation dictionary.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the pronunciation dictionary, used for identification only."},"name":{"type":"string","description":"The name of the pronunciation dictionary, used for identification only."}}},"example":{"description":"","name":""}}}}}},"/v1/speech-to-speech/{voice_id}":{"post":{"tags":["Speech To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/speech-to-speech","api_endpoint":"https://api.elevenlabs.io/v1/speech-to-speech/{voice_id}"},"summary":"Speech To Speech","description":"Use Speech to Speech API to transform uploaded speech so it sounds like it was spoken by another voice","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"audio":{"type":"string","description":"The audio file which holds the content and emotion that will control the generated speech.","required":true},"model_id":{"type":"string","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."},"seed":{"type":"number","description":"If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed."},"voice_settings":{"type":"string","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."}}},"example":{"audio":"","model_id":"","seed":"","voice_settings":""}}}}}},"/v1/voices/{voice_id}/samples/{sample_id}":{"delete":{"tags":["Samples"],"parameters":[{"name":"sample_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-sample","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}/samples/{sample_id}"},"summary":"Delete Sample","description":"Removes a sample by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download":{"get":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"dictionary_id","in":"path","description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}},{"name":"version_id","in":"path","description":"The id of the version of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-id-version_id-download","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/{dictionary_id}/{version_id}/download"},"summary":"Download version by id","description":"Get PLS file with a pronunciation dictionary version rules","security":[{"bearerAuth":[]}]}},"/v1/voices/{voice_id}/samples/{sample_id}/audio":{"get":{"tags":["Samples"],"parameters":[{"name":"sample_id","in":"path","description":"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.","required":true,"schema":{"type":"string","example":""}},{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-audio-from-sample","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}/samples/{sample_id}/audio"},"summary":"Get Audio From Sample","description":"Returns the audio corresponding to a sample attached to a voice.","security":[{"bearerAuth":[]}]}},"/v1/sound-generation":{"post":{"tags":["Sound Effects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/sound-generation","api_endpoint":"https://api.elevenlabs.io/v1/sound-generation"},"summary":"Sound Generation","description":"Create sound effects for your videos, voice-overs or video games.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The text that will get converted into a sound effect.","required":true},"duration_seconds":{"type":"number","description":"The duration of the sound which will be generated in seconds. Must be at least 0.5 and at most 22. If set to None we will guess the optimal duration using the prompt. Defaults to None."},"prompt_influence":{"type":"number","description":"A higher prompt influence makes your generation follow the prompt more closely while also making generations less variable. Must be a value between 0 and 1. Defaults to 0.3."}}},"example":{"text":"","duration_seconds":"","prompt_influence":""}}}}}},"/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules":{"post":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"pronunciation_dictionary_id","in":"path","description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-id-add-rules","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/add-rules"},"summary":"Add rules","description":"Add rules to the pronunciation dictionary","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rules":{"type":"object","description":"List of pronunciation rules. Rule can be either: an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', } or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }","required":true,"properties":{}}}},"example":{"rules":{}}}}}}},"/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules":{"post":{"tags":["Pronunciation Dictionaries"],"parameters":[{"name":"pronunciation_dictionary_id","in":"path","description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/pronunciation-dictionaries-id-remove-rules","api_endpoint":"https://api.elevenlabs.io/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/remove-rules"},"summary":"Remove Rules","description":"Remove rules from the pronunciation dictionary","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rule_strings":{"type":"string","description":"List of strings to remove from the pronunciation dictionary.","required":true}}},"example":{"rule_strings":""}}}}}},"/v1/speech-to-speech/{voice_id}/stream":{"post":{"tags":["Speech To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/speech-to-speech-streaming","api_endpoint":"https://api.elevenlabs.io/v1/speech-to-speech/{voice_id}/stream"},"summary":"Streaming","description":"Create speech by combining the content and emotion of the uploaded audio with a voice of your choice and returns an audio stream.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"audio":{"type":"string","description":"The audio file which holds the content and emotion that will control the generated speech.","required":true},"model_id":{"type":"string","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."},"seed":{"type":"number","description":"If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed."},"voice_settings":{"type":"string","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."}}},"example":{"audio":"","model_id":"","seed":"","voice_settings":""}}}}}},"/v1/text-to-speech/{voice_id}":{"post":{"tags":["Text To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/text-to-speech","api_endpoint":"https://api.elevenlabs.io/v1/text-to-speech/{voice_id}"},"summary":"Text To Speech","description":"API that converts text into lifelike speech with best-in-class latency & uses the most advanced AI audio model ever.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The text that will get converted into speech","required":true},"model_id":{"type":"string","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"},"next_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be send."},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation."},"previous_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be send."},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation"},"pronunciation_dictionary_locators":{"type":"object","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","properties":{}},"seed":{"type":"number","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"},"voice_settings":{"type":"object","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given reques","properties":{}}}},"example":{"text":"","model_id":"","next_request_ids":"","next_text":"","previous_request_ids":"","previous_text":"","pronunciation_dictionary_locators":{},"seed":"","voice_settings":{}}}}}}},"/v1/text-to-speech/{voice_id}/with-timestamps":{"post":{"tags":["Text To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/text-to-speech-with-timestamps","api_endpoint":"https://api.elevenlabs.io/v1/text-to-speech/{voice_id}/with-timestamps"},"summary":"Text To Speech With Timestamps","description":"Converts text into audio together with timestamps on when which word was spoken.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The text that will get converted into speech","required":true},"model_id":{"type":"string","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"},"next_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be send."},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation."},"previous_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be send."},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation"},"pronunciation_dictionary_locators":{"type":"object","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","properties":{}},"seed":{"type":"number","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"},"voice_settings":{"type":"object","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given reques","properties":{}}}},"example":{"text":"","model_id":"","next_request_ids":"","next_text":"","previous_request_ids":"","previous_text":"","pronunciation_dictionary_locators":{},"seed":"","voice_settings":{}}}}}}},"/v1/text-to-speech/{voice_id}/stream":{"post":{"tags":["Text To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/streaming","api_endpoint":"https://api.elevenlabs.io/v1/text-to-speech/{voice_id}/stream"},"summary":"Streaming","description":"Converts text into speech using a voice of your choice and returns audio as an audio stream","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The text that will get converted into speech","required":true},"model_id":{"type":"string","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"},"next_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be send."},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation."},"previous_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be send."},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation"},"pronunciation_dictionary_locators":{"type":"object","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","properties":{}},"seed":{"type":"number","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"},"voice_settings":{"type":"object","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given reques","properties":{}}}},"example":{"text":"","model_id":"","next_request_ids":"","next_text":"","previous_request_ids":"","previous_text":"","pronunciation_dictionary_locators":{},"seed":"","voice_settings":{}}}}}}},"/v1/user":{"get":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-user-info","api_endpoint":"https://api.elevenlabs.io/v1/user"},"summary":"Get User Info","description":"Gets information about the user","security":[{"bearerAuth":[]}]}},"/v1/user/subscription":{"get":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-user-subscription-info","api_endpoint":"https://api.elevenlabs.io/v1/user/subscription"},"summary":"Get User Subscription Info","description":"Gets extended information about the users subscription","security":[{"bearerAuth":[]}]}},"/v1/text-to-speech/{voice_id}/stream/with-timestamps":{"post":{"tags":["Text To Speech"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/streaming-with-timestamps","api_endpoint":"https://api.elevenlabs.io/v1/text-to-speech/{voice_id}/stream/with-timestamps"},"summary":"Text To Speech Streaming With Timestamps","description":"Converts text into audio together with timestamps on when which word was spoken in a streaming way.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The text that will get converted into speech","required":true},"model_id":{"type":"string","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"},"next_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both next_text and next_request_ids is send, next_text will be ignored. A maximum of 3 request_ids can be send."},"next_text":{"type":"string","description":"The text that comes after the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation."},"previous_request_ids":{"type":"string","description":"A list of request_id of the samples that were generated before this generation. Can be used to improve the flow of prosody when splitting up a large task into multiple requests. The results will be best when the same model is used across the generations. In case both previous_text and previous_request_ids is send, previous_text will be ignored. A maximum of 3 request_ids can be send."},"previous_text":{"type":"string","description":"The text that came before the text of the current request. Can be used to improve the flow of prosody when concatenating together multiple generations or to influence the prosody in the current generation"},"pronunciation_dictionary_locators":{"type":"object","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","properties":{}},"seed":{"type":"number","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"},"voice_settings":{"type":"object","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given reques","properties":{}}}},"example":{"text":"","model_id":"","next_request_ids":"","next_text":"","previous_request_ids":"","previous_text":"","pronunciation_dictionary_locators":{},"seed":"","voice_settings":{}}}}}}},"/v1/voice-generation/generate-voice":{"post":{"tags":["Voice Generation"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/generate-voice","api_endpoint":"https://api.elevenlabs.io/v1/voice-generation/generate-voice"},"summary":"Generate A Random Voice","description":"Generate a random voice based on parameters","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Text to generate, text length has to be between 100 and 1000.","required":true},"accent":{"type":"string","description":"Category code corresponding to the accent of the generated voice. Possible values: american, british, african, australian, indian"},"accent_strength":{"type":"number","description":"The strength of the accent of the generated voice. Has to be between 0.3 and 2.0.","required":true},"age":{"type":"enum","description":"Category code corresponding to the age of the generated voice. Possible values: young, middle_aged, old.","required":true,"enum":["young","middle_aged","old"]},"gender":{"type":"enum","description":"Category code corresponding to the gender of the generated voice. Possible values: female, male.","required":true,"enum":["female","male"]}}},"example":{"text":"","accent":"","accent_strength":"","age":"","gender":""}}}}}},"/v1/voice-generation/generate-voice/parameters":{"get":{"tags":["Voice Generation"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/generate-voice-parameters","api_endpoint":"https://api.elevenlabs.io/v1/voice-generation/generate-voice/parameters"},"summary":"Voice Generation Parameters","description":"Voice Generation Parameters","security":[{"bearerAuth":[]}]}},"/v1/shared-voices":{"get":{"tags":["Voice Library"],"parameters":[{"name":"category","in":"query","description":"voice category used for filtering","schema":{"type":"string","example":""}},{"name":"accent","in":"query","description":"accent used for filtering","schema":{"type":"string","example":""}},{"name":"age","in":"query","description":"age used for filtering","schema":{"type":"string","example":""}},{"name":"descriptives","in":"query","description":"search term used for filtering","schema":{"type":"string","example":""}},{"name":"featured","in":"query","description":"Filter featured voices","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"gender","in":"query","description":"gender used for filtering","schema":{"type":"string","example":""}},{"name":"language","in":"query","description":"language used for filtering","schema":{"type":"string","example":""}},{"name":"owner_id","in":"query","description":"Filter voices by public owner ID","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page","schema":{"type":"number","example":""}},{"name":"page_size","in":"query","description":"How many shared voices to return at maximum. Can not exceed 100, defaults to 30.","schema":{"type":"number","example":""}},{"name":"reader_app_enabled","in":"query","description":"Filter voices that are enabled for the reader app","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"search","in":"query","description":"search term used for filtering","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"sort criteria","schema":{"type":"string","example":""}},{"name":"use_cases","in":"query","description":"use-case used for filtering","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/query-library","api_endpoint":"https://api.elevenlabs.io/v1/shared-voices"},"summary":"Get voices","description":"Gets a list of shared voices.","security":[{"bearerAuth":[]}]}},"/v1/voices/add/{public_user_id}/{voice_id}":{"post":{"tags":["Voice Library"],"parameters":[{"name":"public_user_id","in":"path","description":"Public user ID used to publicly identify ElevenLabs users.","required":true,"schema":{"type":"string","example":""}},{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/add-shared-voice","api_endpoint":"https://api.elevenlabs.io/v1/voices/add/{public_user_id}/{voice_id}"},"summary":"Add Sharing Voice","description":"Add a sharing voice to your collection of voices in VoiceLab.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_name":{"type":"string","description":"The name that identifies this voice. This will be displayed in the dropdown of the website.","required":true}}},"example":{"new_name":""}}}}}},"/v1/voices/{voice_id}/settings":{"get":{"tags":["Voices"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-voice-settings","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}/settings"},"summary":"Get Voice Settings","description":"Returns the settings for a specific voice.","security":[{"bearerAuth":[]}]}},"/v1/voices/settings/default":{"get":{"tags":["Voices"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-default-voice-settings","api_endpoint":"https://api.elevenlabs.io/v1/voices/settings/default"},"summary":"Get Default Voice Settings.","description":"Gets the default settings for voices.","security":[{"bearerAuth":[]}]}},"/v1/voices":{"get":{"tags":["Voices"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-voices","api_endpoint":"https://api.elevenlabs.io/v1/voices"},"summary":"Get Voices","description":"Gets a list of all available voices for a user.","security":[{"bearerAuth":[]}]}},"/v1/voices/{voice_id}":{"get":{"tags":["Voices"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}},{"name":"with_settings","in":"query","description":"If set will return settings information corresponding to the voice, requires authorization","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/get-voice","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}"},"summary":"Get Voice","description":"Returns metadata about a specific voice.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Voices"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/delete-voice","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}"},"summary":"Delete Voice","description":"Deletes a voice by its ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/voices/add":{"post":{"tags":["Voices"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/add-voice","api_endpoint":"https://api.elevenlabs.io/v1/voices/add"},"summary":"Add Voice","description":"Add a new voice to your collection of voices in VoiceLab.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"How would you describe the voice?"},"files":{"type":"string","description":"A list of file paths to audio recordings intended for voice cloning","required":true},"labels":{"type":"string","description":"Serialized labels dictionary for the voice."},"name":{"type":"string","description":"The name that identifies this voice. This will be displayed in the dropdown of the website.","required":true}}},"example":{"description":"","files":"","labels":"","name":""}}}}}},"/v1/workspace/invites":{"delete":{"tags":["Workspace"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/workspace-delete-invite","api_endpoint":"https://api.elevenlabs.io/v1/workspace/invites"},"summary":"Delete Existing Invitation","description":"Invalidates an existing email invitation. The invitation will still show up in the inbox it has been delivered to, but activating it to join the workspace won’t work. This endpoint may only be called by workspace administrators.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email of the target user.","required":true}}},"example":{"email":""}}}}}},"/v1/voices/{voice_id}/settings/edit":{"post":{"tags":["Voices"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/edit-voice-settings","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}/settings/edit"},"summary":"Edit Voice Settings","description":"Edit your settings for a specific voice.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"similarity_boost":{"type":"number","description":"Similarity boost corresponds to Clarity  Similarity Enhancement","required":true},"stability":{"type":"number","description":"Stability of the voice","required":true},"style":{"type":"number","description":"Style"},"use_speaker_boost":{"type":"boolean","description":"Use speaker boost","enum":[true,false]}}},"example":{"similarity_boost":"","stability":"","style":"","use_speaker_boost":""}}}}}},"/v1/workspace/invites/add":{"post":{"tags":["Workspace"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/workspace-invite-user","api_endpoint":"https://api.elevenlabs.io/v1/workspace/invites/add"},"summary":"Invite User","description":"Sends an email invitation to join your workspace to the provided email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email of the target user.","required":true}}},"example":{"email":""}}}}}},"/v1/workspace/members":{"post":{"tags":["Workspace"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/workspace-update-member","api_endpoint":"https://api.elevenlabs.io/v1/workspace/members"},"summary":"Update Member","description":"Updates attributes of a workspace member.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email of the target user.","required":true},"is_locked":{"type":"boolean","description":"Whether to lock or unlock the user account.","enum":[true,false]},"language_code":{"type":"string","description":"ID of the language.","required":true},"workspace_role":{"type":"enum","description":"Role dictating permissions in the workspace.","enum":["workspace_admin","workspace_member"]}}},"example":{"email":"","is_locked":"","language_code":"","workspace_role":""}}}}},"get":{"tags":["Workspace"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/workspace-get-members","api_endpoint":"https://api.elevenlabs.io/v1/workspace/members"},"summary":"Get Workspace Members","description":"Returns a list of all workspace members and their metadata.","security":[{"bearerAuth":[]}]}},"/v1/voices/{voice_id}/edit":{"post":{"tags":["Voices"],"parameters":[{"name":"voice_id","in":"path","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/edit-voice","api_endpoint":"https://api.elevenlabs.io/v1/voices/{voice_id}/edit"},"summary":"Edit Voice","description":"Edit a voice created by you.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"How would you describe the voice?"},"files":{"type":"string","description":"A list of file paths to audio recordings intended for voice cloning","required":true},"labels":{"type":"string","description":"Serialized labels dictionary for the voice."},"name":{"type":"string","description":"The name that identifies this voice. This will be displayed in the dropdown of the website.","required":true}}},"example":{"description":"","files":"","labels":"","name":""}}}}}},"/v1/text-to-dialogue":{"post":{"tags":["Text To Speech"],"parameters":[{"name":"enable_logging","in":"query","description":"When enable_logging is set to false full privacy mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Full privacy mode may only be used by enterprise customers.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"optimize_streaming_latency","in":"query","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model","schema":{"type":"number","example":""}},{"name":"output_format","in":"query","description":"Output format of the generated audio. Must be one of: mp3_22050_32 - output format, mp3 with 22.05kHz sample rate at 32kbps. mp3_44100_32 - output format, mp3 with 44.1kHz sample rate at 32kbps. mp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps. mp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps. mp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps. mp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above. pcm_16000 - PCM format (S16LE) with 16kHz sample rate. pcm_22050 - PCM format (S16LE) with 22.05kHz sample rate. pcm_24000 - PCM format (S16LE) with 24kHz sample rate. pcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Pro tier or above. ulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/text-to-dialogue","api_endpoint":"https://api.elevenlabs.io/v1/text-to-dialogue"},"summary":"Text To Dialogue","description":"Converts a list of text and voice ID pairs into speech (dialogue) and returns audio.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dialogue":{"type":"array","description":"A list of text and voice ID pairs to convert into speech (dialogue).","required":true,"items":{"type":"string"}},"model_id":{"type":"string","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"}}},"example":{"dialogue":[],"model_id":""}}}}}},"/v1/text-to-voice":{"post":{"tags":["Voice Generation"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elevenlabs.io/docs/api-reference/text-to-voice","api_endpoint":"https://api.elevenlabs.io/v1/text-to-voice"},"summary":"Text To Voice Design","description":"Design a voice via a prompt, returning a list of voice previews.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Text prompt used to design the voice.","required":true},"accent":{"type":"string","description":"Category code corresponding to the accent of the generated voice. Possible values: american, british, african, australian, indian"},"accent_strength":{"type":"number","description":"The strength of the accent of the generated voice. Has to be between 0.3 and 2.0."},"age":{"type":"enum","description":"Category code corresponding to the age of the generated voice. Possible values: young, middle_aged, old.","enum":["young","middle_aged","old"]},"gender":{"type":"enum","description":"Category code corresponding to the gender of the generated voice. Possible values: female, male.","enum":["female","male"]}}},"example":{"text":"","accent":"","accent_strength":"","age":"","gender":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}