diff --git a/poetry.lock b/poetry.lock
index 40eac025..e95daa8c 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -186,13 +186,13 @@ files = [
[[package]]
name = "httpcore"
-version = "1.0.7"
+version = "1.0.8"
description = "A minimal low-level HTTP client."
optional = false
python-versions = ">=3.8"
files = [
- {file = "httpcore-1.0.7-py3-none-any.whl", hash = "sha256:a3fff8f43dc260d5bd363d9f9cf1830fa3a458b332856f34282de498ed420edd"},
- {file = "httpcore-1.0.7.tar.gz", hash = "sha256:8551cb62a169ec7162ac7be8d4817d561f60e08eaa485234898414bb5a8a0b4c"},
+ {file = "httpcore-1.0.8-py3-none-any.whl", hash = "sha256:5254cf149bcb5f75e9d1b2b9f729ea4a4b883d1ad7379fc632b727cec23674be"},
+ {file = "httpcore-1.0.8.tar.gz", hash = "sha256:86e94505ed24ea06514883fd44d2bc02d90e77e7979c8eb71b90f41d364a1bad"},
]
[package.dependencies]
@@ -683,13 +683,13 @@ files = [
[[package]]
name = "typing-extensions"
-version = "4.13.0"
+version = "4.13.2"
description = "Backported and Experimental Type Hints for Python 3.8+"
optional = false
python-versions = ">=3.8"
files = [
- {file = "typing_extensions-4.13.0-py3-none-any.whl", hash = "sha256:c8dd92cc0d6425a97c18fbb9d1954e5ff92c1ca881a309c45f06ebc0b79058e5"},
- {file = "typing_extensions-4.13.0.tar.gz", hash = "sha256:0a4ac55a5820789d87e297727d229866c9650f6521b64206413c4fbada24d95b"},
+ {file = "typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c"},
+ {file = "typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index 07adb9f4..223f664a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ name = "elevenlabs"
[tool.poetry]
name = "elevenlabs"
-version = "1.56.1"
+version = "1.57.0"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index 93e407aa..16d14a0a 100644
--- a/reference.md
+++ b/reference.md
@@ -1626,6 +1626,14 @@ Defaults to None.
-
+**file_format:** `typing.Optional[SpeechToSpeechConvertRequestFileFormat]` — The format of input audio. Options are 'pcm_s16le_16' or 'other' For `pcm_s16le_16`, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. Latency will be lower than with passing an encoded waveform.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -1773,6 +1781,14 @@ Defaults to None.
-
+**file_format:** `typing.Optional[SpeechToSpeechConvertAsStreamRequestFileFormat]` — The format of input audio. Options are 'pcm_s16le_16' or 'other' For `pcm_s16le_16`, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. Latency will be lower than with passing an encoded waveform.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -2591,6 +2607,14 @@ client.voices.search(
-
+**collection_id:** `typing.Optional[str]` — Collection ID to filter voices by.
+
+
+
+
+
+-
+
**include_total_count:** `typing.Optional[bool]` — Whether to include the total count of voices found in the response. Incurs a performance cost.
@@ -2973,10304 +2997,3 @@ client.voices.edit_settings(
client.voices.add(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Add a new voice to your collection of voices in VoiceLab.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.add(
- name="Alex",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name that identifies this voice. This will be displayed in the dropdown of the website.
-
-
-
-
-
--
-
-**files:** `from __future__ import annotations
-
-typing.List[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**remove_background_noise:** `typing.Optional[bool]` — If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — A description of the voice.
-
-
-
-
-
--
-
-**labels:** `typing.Optional[str]` — Serialized labels dictionary for the voice.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.voices.edit(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Edit a voice created by you.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.edit(
- voice_id="VOICE_ID",
- name="George",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**voice_id:** `str` — Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
-
-
-
-
-
--
-
-**name:** `str` — The name that identifies this voice. This will be displayed in the dropdown of the website.
-
-
-
-
-
--
-
-**files:** `from __future__ import annotations
-
-typing.Optional[typing.List[core.File]]` — See core.File for more documentation
-
-
-
-
-
--
-
-**remove_background_noise:** `typing.Optional[bool]` — If set will remove background noise for voice samples using our audio isolation model. If the samples do not include background noise, it can make the quality worse.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — A description of the voice.
-
-
-
-
-
--
-
-**labels:** `typing.Optional[str]` — Serialized labels dictionary for the voice.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.voices.add_sharing_voice(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Add a shared voice to your collection of voices.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.add_sharing_voice(
- public_user_id="63e84100a6bf7874ba37a1bab9a31828a379ec94b891b401653b655c5110880f",
- voice_id="sB1b5zUrxQVAFl2PhZFp",
- new_name="Alita",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**public_user_id:** `str` — Public user ID used to publicly identify ElevenLabs users.
-
-
-
-
-
--
-
-**voice_id:** `str` — Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
-
-
-
-
-
--
-
-**new_name:** `str` — The name that identifies this voice. This will be displayed in the dropdown of the website.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.voices.get_shared(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieves a list of shared voices.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.get_shared(
- page_size=1,
- gender="female",
- language="en",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many shared voices to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**category:** `typing.Optional[VoicesGetSharedRequestCategory]` — Voice category used for filtering
-
-
-
-
-
--
-
-**gender:** `typing.Optional[str]` — Gender used for filtering
-
-
-
-
-
--
-
-**age:** `typing.Optional[str]` — Age used for filtering
-
-
-
-
-
--
-
-**accent:** `typing.Optional[str]` — Accent used for filtering
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — Language used for filtering
-
-
-
-
-
--
-
-**locale:** `typing.Optional[str]` — Locale used for filtering
-
-
-
-
-
--
-
-**search:** `typing.Optional[str]` — Search term used for filtering
-
-
-
-
-
--
-
-**use_cases:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Use-case used for filtering
-
-
-
-
-
--
-
-**descriptives:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Search term used for filtering
-
-
-
-
-
--
-
-**featured:** `typing.Optional[bool]` — Filter featured voices
-
-
-
-
-
--
-
-**min_notice_period_days:** `typing.Optional[int]` — Filter voices with a minimum notice period of the given number of days.
-
-
-
-
-
--
-
-**reader_app_enabled:** `typing.Optional[bool]` — Filter voices that are enabled for the reader app
-
-
-
-
-
--
-
-**owner_id:** `typing.Optional[str]` — Filter voices by public owner ID
-
-
-
-
-
--
-
-**sort:** `typing.Optional[str]` — Sort criteria
-
-
-
-
-
--
-
-**page:** `typing.Optional[int]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.voices.get_similar_library_voices(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of shared voices similar to the provided audio sample. If neither similarity_threshold nor top_k is provided, we will apply default values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.get_similar_library_voices()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**audio_file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**similarity_threshold:** `typing.Optional[float]` — Threshold for voice similarity between provided sample and library voices. Values range from 0 to 2. The smaller the value the more similar voices will be returned.
-
-
-
-
-
--
-
-**top_k:** `typing.Optional[int]` — Number of most similar voices to return. If similarity_threshold is provided, less than this number of voices may be returned. Values range from 1 to 100.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.voices.get_a_profile_page(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets a profile page based on a handle
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.voices.get_a_profile_page(
- handle="talexgeorge",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**handle:** `str` — Handle for a VA's profile page
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.create_podcast(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create and auto-convert a podcast project. Currently, the LLM cost is covered by us but you will still be charged for the audio generation. In the future, you will be charged for both the LLM and audio generation costs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import (
- ElevenLabs,
- PodcastConversationModeData,
- PodcastTextSource,
-)
-from elevenlabs.studio import (
- BodyCreatePodcastV1StudioPodcastsPostMode_Conversation,
-)
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.create_podcast(
- model_id="21m00Tcm4TlvDq8ikWAM",
- mode=BodyCreatePodcastV1StudioPodcastsPostMode_Conversation(
- conversation=PodcastConversationModeData(
- host_voice_id="aw1NgEzBg83R7vgmiJt6",
- guest_voice_id="aw1NgEzBg83R7vgmiJt7",
- ),
- ),
- source=PodcastTextSource(
- text="This is a test podcast.",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model_id:** `str` — The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.
-
-
-
-
-
--
-
-**mode:** `BodyCreatePodcastV1StudioPodcastsPostMode` — The type of podcast to generate. Can be 'conversation', an interaction between two voices, or 'bulletin', a monologue.
-
-
-
-
-
--
-
-**source:** `BodyCreatePodcastV1StudioPodcastsPostSource` — The source content for the Podcast.
-
-
-
-
-
--
-
-**quality_preset:** `typing.Optional[BodyCreatePodcastV1StudioPodcastsPostQualityPreset]`
-
-Output quality of the generated audio. Must be one of:
-standard - standard output format, 128kbps with 44.1kHz sample rate.
-high - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the credit cost by 20%.
-ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the credit cost by 50%.
-ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the credit cost by 100%.
-
-
-
-
-
--
-
-**duration_scale:** `typing.Optional[BodyCreatePodcastV1StudioPodcastsPostDurationScale]`
-
-Duration of the generated podcast. Must be one of:
-short - produces podcasts shorter than 3 minutes.
-default - produces podcasts roughly between 3-7 minutes.
-long - prodces podcasts longer than 7 minutes.
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — An optional language of the Studio project. Two-letter language code (ISO 639-1).
-
-
-
-
-
--
-
-**highlights:** `typing.Optional[typing.Sequence[str]]` — A brief summary or highlights of the Studio project's content, providing key points or themes. This should be between 10 and 70 characters.
-
-
-
-
-
--
-
-**callback_url:** `typing.Optional[str]` — A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.create_podcast(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create and auto-convert a podcast project. Currently, the LLM cost is covered by us but you will still be charged for the audio generation. In the future, you will be charged for both the LLM and audio generation costs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import (
- ElevenLabs,
- PodcastConversationModeData,
- PodcastTextSource,
-)
-from elevenlabs.projects import (
- BodyCreatePodcastV1ProjectsPodcastCreatePostMode_Conversation,
-)
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.create_podcast(
- model_id="21m00Tcm4TlvDq8ikWAM",
- mode=BodyCreatePodcastV1ProjectsPodcastCreatePostMode_Conversation(
- conversation=PodcastConversationModeData(
- host_voice_id="aw1NgEzBg83R7vgmiJt6",
- guest_voice_id="aw1NgEzBg83R7vgmiJt7",
- ),
- ),
- source=PodcastTextSource(
- text="This is a test podcast.",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model_id:** `str` — The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.
-
-
-
-
-
--
-
-**mode:** `BodyCreatePodcastV1ProjectsPodcastCreatePostMode` — The type of podcast to generate. Can be 'conversation', an interaction between two voices, or 'bulletin', a monologue.
-
-
-
-
-
--
-
-**source:** `BodyCreatePodcastV1ProjectsPodcastCreatePostSource` — The source content for the Podcast.
-
-
-
-
-
--
-
-**quality_preset:** `typing.Optional[BodyCreatePodcastV1ProjectsPodcastCreatePostQualityPreset]`
-
-Output quality of the generated audio. Must be one of:
-standard - standard output format, 128kbps with 44.1kHz sample rate.
-high - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the credit cost by 20%.
-ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the credit cost by 50%.
-ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the credit cost by 100%.
-
-
-
-
-
--
-
-**duration_scale:** `typing.Optional[BodyCreatePodcastV1ProjectsPodcastCreatePostDurationScale]`
-
-Duration of the generated podcast. Must be one of:
-short - produces podcasts shorter than 3 minutes.
-default - produces podcasts roughly between 3-7 minutes.
-long - prodces podcasts longer than 7 minutes.
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — An optional language of the Studio project. Two-letter language code (ISO 639-1).
-
-
-
-
-
--
-
-**highlights:** `typing.Optional[typing.Sequence[str]]` — A brief summary or highlights of the Studio project's content, providing key points or themes. This should be between 10 and 70 characters.
-
-
-
-
-
--
-
-**callback_url:** `typing.Optional[str]` — A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.get_projects()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of your projects together and its metadata.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.get_projects()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.add_project(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new project, it can be either initialized as blank, from a document or from a URL.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.add_project(
- name="name",
- default_title_voice_id="default_title_voice_id",
- default_paragraph_voice_id="default_paragraph_voice_id",
- default_model_id="default_model_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the Studio project, used for identification only.
-
-
-
-
-
--
-
-**default_title_voice_id:** `str` — The voice_id that corresponds to the default voice used for new titles.
-
-
-
-
-
--
-
-**default_paragraph_voice_id:** `str` — The voice_id that corresponds to the default voice used for new paragraphs.
-
-
-
-
-
--
-
-**default_model_id:** `str` — The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**from_document:** `typing.Optional[str]` — An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**quality_preset:** `typing.Optional[str]`
-
-Output quality of the generated audio. Must be one of:
-standard - standard output format, 128kbps with 44.1kHz sample rate.
-high - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the credit cost by 20%.
-ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the credit cost by 50%.
-ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the credit cost by 100%.
-
-
-
-
-
--
-
-**title:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**author:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — An optional description of the Studio project.
-
-
-
-
-
--
-
-**genres:** `typing.Optional[typing.List[str]]` — An optional list of genres associated with the Studio project.
-
-
-
-
-
--
-
-**target_audience:** `typing.Optional[AddProjectV1ProjectsAddPostRequestTargetAudience]` — An optional target audience of the Studio project.
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — An optional language of the Studio project. Two-letter language code (ISO 639-1).
-
-
-
-
-
--
-
-**content_type:** `typing.Optional[str]` — An optional content type of the Studio project.
-
-
-
-
-
--
-
-**original_publication_date:** `typing.Optional[str]` — An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY.
-
-
-
-
-
--
-
-**mature_content:** `typing.Optional[bool]` — An optional specification of whether this Studio project contains mature content.
-
-
-
-
-
--
-
-**isbn_number:** `typing.Optional[str]` — An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**acx_volume_normalization:** `typing.Optional[bool]` — [Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**volume_normalization:** `typing.Optional[bool]` — When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**pronunciation_dictionary_locators:** `typing.Optional[typing.List[str]]` — A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. Note that multiple dictionaries are not currently supported by our UI which will only show the first.
-
-
-
-
-
--
-
-**fiction:** `typing.Optional[AddProjectV1ProjectsAddPostRequestFiction]` — An optional specification of whether the content of this Studio project is fiction.
-
-
-
-
-
--
-
-**apply_text_normalization:** `typing.Optional[AddProjectV1ProjectsAddPostRequestApplyTextNormalization]`
-
-
- This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.
- When set to 'auto', the system will automatically decide whether to apply text normalization
- (e.g., spelling out numbers). With 'on', text normalization will always be applied, while
- with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.
-
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the Studio project to audio or not.
-
-
-
-
-
--
-
-**auto_assign_voices:** `typing.Optional[bool]` — [Alpha Feature] Whether automatically assign voices to phrases in the create Project.
-
-
-
-
-
--
-
-**source_type:** `typing.Optional[AddProjectV1ProjectsAddPostRequestSourceType]` — The type of Studio project to create.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.get_project_by_id(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns information about a specific project. This endpoint returns more detailed information about a project than `GET /v1/projects`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.get_project_by_id(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.edit_basic_project_info(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Edits basic project info.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.edit_basic_project_info(
- project_id="21m00Tcm4TlvDq8ikWAM",
- name="Project 1",
- default_title_voice_id="21m00Tcm4TlvDq8ikWAM",
- default_paragraph_voice_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**name:** `str` — The name of the Studio project, used for identification only.
-
-
-
-
-
--
-
-**default_title_voice_id:** `str` — The voice_id that corresponds to the default voice used for new titles.
-
-
-
-
-
--
-
-**default_paragraph_voice_id:** `str` — The voice_id that corresponds to the default voice used for new paragraphs.
-
-
-
-
-
--
-
-**title:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**author:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**isbn_number:** `typing.Optional[str]` — An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**volume_normalization:** `typing.Optional[bool]` — When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.delete_project(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.delete_project(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.edit_project_content(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Edits project content.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.edit_project_content(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**from_document:** `typing.Optional[str]` — An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the Studio project to audio or not.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.convert_project(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Starts conversion of a project and all of its chapters.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.convert_project(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.get_project_snapshots(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets the snapshots of a project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.get_project_snapshots(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.streams_archive_with_project_audio(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Streams archive with project audio.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.streams_archive_with_project_audio(
- project_id="21m00Tcm4TlvDq8ikWAM",
- project_snapshot_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**project_snapshot_id:** `str` — The ID of the Studio project snapshot.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.get_chapters(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of your chapters for a project together and its metadata.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.get_chapters(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.get_chapter_by_id(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns information about a specific chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.get_chapter_by_id(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.delete_chapter(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.delete_chapter(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.edit_chapter(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Edits a chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.edit_chapter(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — The name of the chapter, used for identification only.
-
-
-
-
-
--
-
-**content:** `typing.Optional[ChapterContentInputModel]` — The chapter content to use.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.add_chapter_to_a_project(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new chapter either as blank or from a URL.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.add_chapter_to_a_project(
- project_id="21m00Tcm4TlvDq8ikWAM",
- name="Chapter 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**name:** `str` — The name of the chapter, used for identification only.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.convert_chapter(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Starts conversion of a specific chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.convert_chapter(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.list_chapter_snapshots(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets information about all the snapshots of a chapter. Each snapshot can be downloaded as audio. Whenever a chapter is converted a snapshot will automatically be created.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.list_chapter_snapshots(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.stream_chapter_audio(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Stream the audio from a chapter snapshot. Use `GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots` to return the chapter snapshots of a chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.stream_chapter_audio(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
- chapter_snapshot_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**chapter_snapshot_id:** `str` — The ID of the chapter snapshot.
-
-
-
-
-
--
-
-**convert_to_mpeg:** `typing.Optional[bool]` — Whether to convert the audio to mpeg format.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.projects.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.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs, PronunciationDictionaryVersionLocator
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.projects.update_pronunciation_dictionaries(
- project_id="21m00Tcm4TlvDq8ikWAM",
- pronunciation_dictionary_locators=[
- PronunciationDictionaryVersionLocator(
- pronunciation_dictionary_id="pronunciation_dictionary_id",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**pronunciation_dictionary_locators:** `typing.Sequence[PronunciationDictionaryVersionLocator]` — A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. Note that multiple dictionaries are not currently supported by our UI which will only show the first.
-
-
-
-
-
--
-
-**invalidate_affected_text:** `typing.Optional[bool]` — This will automatically mark text in this project for reconversion when the new dictionary applies or the old one no longer does.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.get_dubbing_resource(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Given a dubbing ID generated from the '/v1/dubbing' endpoint with studio enabled, returns the dubbing resource.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.get_dubbing_resource(
- dubbing_id="dubbing_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.add_language_to_resource(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Adds the given ElevenLab Turbo V2/V2.5 language code to the resource. Does not automatically generate transcripts/translations/audio.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.add_language_to_resource(
- dubbing_id="dubbing_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — The Target language.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.create_segment_for_speaker(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new segment in dubbing resource with a start and end time for the speaker in every available language. Does not automatically generate transcripts/translations/audio.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.create_segment_for_speaker(
- dubbing_id="dubbing_id",
- speaker_id="speaker_id",
- start_time=1.1,
- end_time=1.1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**speaker_id:** `str` — ID of the speaker.
-
-
-
-
-
--
-
-**start_time:** `float`
-
-
-
-
-
--
-
-**end_time:** `float`
-
-
-
-
-
--
-
-**text:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.update_segment_language(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Modifies a single segment with new text and/or start/end times. Will update the values for only a specific language of a segment. Does not automatically regenerate the dub.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.update_segment_language(
- dubbing_id="dubbing_id",
- segment_id="segment_id",
- language="language",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**segment_id:** `str` — ID of the segment
-
-
-
-
-
--
-
-**language:** `str` — ID of the language.
-
-
-
-
-
--
-
-**start_time:** `typing.Optional[float]`
-
-
-
-
-
--
-
-**end_time:** `typing.Optional[float]`
-
-
-
-
-
--
-
-**text:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.delete_segment(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a single segment from the dubbing.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.delete_segment(
- dubbing_id="dubbing_id",
- segment_id="segment_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**segment_id:** `str` — ID of the segment
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.transcribe_segments(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Regenerate the transcriptions for the specified segments. Does not automatically regenerate translations or dubs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.transcribe_segments(
- dubbing_id="dubbing_id",
- segments=["segments"],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**segments:** `typing.Sequence[str]` — Transcribe this specific list of segments.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.translate_segments(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Regenerate the translations for either the entire resource or the specified segments/languages. Will automatically transcribe missing transcriptions. Will not automatically regenerate the dubs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.translate_segments(
- dubbing_id="dubbing_id",
- segments=["segments"],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**segments:** `typing.Sequence[str]` — Translate only this list of segments.
-
-
-
-
-
--
-
-**languages:** `typing.Optional[typing.Sequence[str]]` — Translate only these languages for each segment.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.dub_segments(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Regenerate the dubs for either the entire resource or the specified segments/languages. Will automatically transcribe and translate any missing transcriptions and translations.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.dub_segments(
- dubbing_id="dubbing_id",
- segments=["segments"],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**segments:** `typing.Sequence[str]` — Dub only this list of segments.
-
-
-
-
-
--
-
-**languages:** `typing.Optional[typing.Sequence[str]]` — Dub only these languages for each segment.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.dub_a_video_or_an_audio_file(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Dubs a provided audio or video file into given language.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.dub_a_video_or_an_audio_file()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**file:** `typing.Optional[str]` — A list of file paths to audio recordings intended for voice cloning
-
-
-
-
-
--
-
-**csv_file:** `typing.Optional[str]` — CSV file containing transcription/translation metadata
-
-
-
-
-
--
-
-**foreground_audio_file:** `typing.Optional[str]` — For use only with csv input
-
-
-
-
-
--
-
-**background_audio_file:** `typing.Optional[str]` — For use only with csv input
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — Name of the dubbing project.
-
-
-
-
-
--
-
-**source_url:** `typing.Optional[str]` — URL of the source video/audio file.
-
-
-
-
-
--
-
-**source_lang:** `typing.Optional[str]` — Source language.
-
-
-
-
-
--
-
-**target_lang:** `typing.Optional[str]` — The Target language to dub the content into.
-
-
-
-
-
--
-
-**num_speakers:** `typing.Optional[int]` — Number of speakers to use for the dubbing. Set to 0 to automatically detect the number of speakers
-
-
-
-
-
--
-
-**watermark:** `typing.Optional[bool]` — Whether to apply watermark to the output video.
-
-
-
-
-
--
-
-**start_time:** `typing.Optional[int]` — Start time of the source video/audio file.
-
-
-
-
-
--
-
-**end_time:** `typing.Optional[int]` — End time of the source video/audio file.
-
-
-
-
-
--
-
-**highest_resolution:** `typing.Optional[bool]` — Whether to use the highest resolution available.
-
-
-
-
-
--
-
-**drop_background_audio:** `typing.Optional[bool]` — An advanced setting. Whether to drop background audio from the final dub. This can improve dub quality where it's known that audio shouldn't have a background track such as for speeches or monologues.
-
-
-
-
-
--
-
-**use_profanity_filter:** `typing.Optional[bool]` — [BETA] Whether transcripts should have profanities censored with the words '[censored]'
-
-
-
-
-
--
-
-**dubbing_studio:** `typing.Optional[bool]` — Whether to prepare dub for edits in dubbing studio or edits as a dubbing resource.
-
-
-
-
-
--
-
-**disable_voice_cloning:** `typing.Optional[bool]` — [BETA] Instead of using a voice clone in dubbing, use a similar voice from the ElevenLabs Voice Library.
-
-
-
-
-
--
-
-**mode:** `typing.Optional[str]` — automatic or manual. Manual mode is only supported when creating a dubbing studio project
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.get_dubbing_project_metadata(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata about a dubbing project, including whether it's still in progress or not
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.get_dubbing_project_metadata(
- dubbing_id="dubbing_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.delete_dubbing_project(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a dubbing project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.delete_dubbing_project(
- dubbing_id="dubbing_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.dubbing.get_transcript_for_dub(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns transcript for the dub as an SRT or WEBVTT file.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.dubbing.get_transcript_for_dub(
- dubbing_id="dubbing_id",
- language_code="language_code",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**dubbing_id:** `str` — ID of the dubbing project.
-
-
-
-
-
--
-
-**language_code:** `str` — ID of the language.
-
-
-
-
-
--
-
-**format_type:** `typing.Optional[DubbingGetTranscriptForDubRequestFormatType]` — Format to use for the subtitle file, either 'srt' or 'webvtt'
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.models.get_all()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets a list of available models.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.models.get_all()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.audio_native.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.audio_native.create(
- name="name",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — Project name.
-
-
-
-
-
--
-
-**image:** `typing.Optional[str]` — (Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
-
-
-
-
-
--
-
-**author:** `typing.Optional[str]` — 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.
-
-
-
-
-
--
-
-**title:** `typing.Optional[str]` — 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.
-
-
-
-
-
--
-
-**small:** `typing.Optional[bool]` — (Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
-
-
-
-
-
--
-
-**text_color:** `typing.Optional[str]` — Text color used in the player. If not provided, default text color set in the Player settings is used.
-
-
-
-
-
--
-
-**background_color:** `typing.Optional[str]` — Background color used in the player. If not provided, default background color set in the Player settings is used.
-
-
-
-
-
--
-
-**sessionization:** `typing.Optional[int]` — (Deprecated) Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used.
-
-
-
-
-
--
-
-**voice_id:** `typing.Optional[str]` — Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
-
-
-
-
-
--
-
-**model_id:** `typing.Optional[str]` — TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
-
-
-
-
-
--
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.audio_native.get_settings(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get player settings for the specific project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.audio_native.get_settings(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.audio_native.update_content(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates content for the specific AudioNative Project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.audio_native.update_content(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
-
-
-
-
-
--
-
-**auto_publish:** `typing.Optional[bool]` — Whether to auto publish the new project snapshot after it's converted.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.usage.get_characters_usage_metrics(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the credit usage metrics for the current user or the entire workspace they are part of. The response will return a time axis with unix timestamps for each day and daily usage along that axis. The usage will be broken down by the specified breakdown type. For example, breakdown type "voice" will return the usage of each voice along the time axis.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.usage.get_characters_usage_metrics(
- start_unix=1,
- end_unix=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**start_unix:** `int` — UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
-
-
-
-
-
--
-
-**end_unix:** `int` — UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
-
-
-
-
-
--
-
-**include_workspace_metrics:** `typing.Optional[bool]` — Whether or not to include the statistics of the entire workspace.
-
-
-
-
-
--
-
-**breakdown_type:** `typing.Optional[BreakdownTypes]` — How to break down the information. Cannot be "user" if include_workspace_metrics is False.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.add_from_file(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new pronunciation dictionary from a lexicon .PLS file
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.add_from_file(
- name="name",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**file:** `typing.Optional[str]` — A lexicon .pls file which we will use to initialize the project with.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**workspace_access:** `typing.Optional[PronunciationDictionaryAddFromFileRequestWorkspaceAccess]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.add_from_rules(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new pronunciation dictionary from provided rules.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-from elevenlabs.pronunciation_dictionary import (
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias,
-)
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.add_from_rules(
- rules=[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias(
- string_to_replace="Thailand",
- alias="tie-land",
- )
- ],
- name="My Dictionary",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**rules:** `typing.Sequence[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem
-]`
-
-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' }
-
-
-
-
-
--
-
-**name:** `str` — The name of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**workspace_access:** `typing.Optional[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostWorkspaceAccess
-]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.add_rules(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Add rules to the pronunciation dictionary
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-from elevenlabs.pronunciation_dictionary import (
- PronunciationDictionaryRule_Alias,
-)
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.add_rules(
- pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
- rules=[
- PronunciationDictionaryRule_Alias(
- string_to_replace="Thailand",
- alias="tie-land",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
-
-
-
-
-
--
-
-**rules:** `typing.Sequence[PronunciationDictionaryRule]`
-
-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' }
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.remove_rules(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Remove rules from the pronunciation dictionary
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.remove_rules(
- pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
- rule_strings=["rule_strings"],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
-
-
-
-
-
--
-
-**rule_strings:** `typing.Sequence[str]` — List of strings to remove from the pronunciation dictionary.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.get(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get metadata for a pronunciation dictionary
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.get(
- pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.pronunciation_dictionary.get_all(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a list of the pronunciation dictionaries you have access to and their metadata
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionary.get_all()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**sort:** `typing.Optional[PronunciationDictionaryGetAllRequestSort]` — Which field to sort by, one of 'created_at_unix' or 'name'.
-
-
-
-
-
--
-
-**sort_direction:** `typing.Optional[str]` — Which direction to sort the voices in. 'ascending' or 'descending'.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.search_user_groups(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Searches for user groups in the workspace. Multiple or no groups may be returned.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.search_user_groups(
- name="name",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — Name of the target group.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.delete_member_from_user_group(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Removes a member from the specified group. This endpoint may only be called by workspace administrators.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.delete_member_from_user_group(
- group_id="group_id",
- email="email",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**group_id:** `str` — The ID of the target group.
-
-
-
-
-
--
-
-**email:** `str` — The email of the target workspace member.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.add_member_to_user_group(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Adds a member of your workspace to the specified group. This endpoint may only be called by workspace administrators.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.add_member_to_user_group(
- group_id="group_id",
- email="email",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**group_id:** `str` — The ID of the target group.
-
-
-
-
-
--
-
-**email:** `str` — The email of the target workspace member.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.invite_user(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Sends an email invitation to join your workspace to the provided email. If the user doesn't have an account they will be prompted to create one. If the user accepts this invite they will be added as a user to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace administrators. If the user is already in the workspace a 400 error will be returned.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.invite_user(
- email="john.doe@testmail.com",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**email:** `str` — The email of the customer
-
-
-
-
-
--
-
-**group_ids:** `typing.Optional[typing.Sequence[str]]` — The group ids of the user
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.invite_multiple_users(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Sends email invitations to join your workspace to the provided emails. Requires all email addresses to be part of a verified domain. If the users don't have an account they will be prompted to create one. If the users accept these invites they will be added as users to your workspace and your subscription using one of your seats. This endpoint may only be called by workspace administrators.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.invite_multiple_users(
- emails=["emails"],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**emails:** `typing.Sequence[str]` — The email of the customer
-
-
-
-
-
--
-
-**group_ids:** `typing.Optional[typing.Sequence[str]]` — The group ids of the user
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.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.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.delete_existing_invitation(
- email="john.doe@testmail.com",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**email:** `str` — The email of the customer
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.update_member(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates attributes of a workspace member. Apart from the email identifier, all parameters will remain unchanged unless specified. This endpoint may only be called by workspace administrators.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.update_member(
- email="email",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**email:** `str` — Email of the target user.
-
-
-
-
-
--
-
-**is_locked:** `typing.Optional[bool]` — Whether to lock or unlock the user account.
-
-
-
-
-
--
-
-**workspace_role:** `typing.Optional[BodyUpdateMemberV1WorkspaceMembersPostWorkspaceRole]` — Role dictating permissions in the workspace.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.get_resource(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets the metadata of a resource by ID.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.get_resource(
- resource_id="resource_id",
- resource_type="voice",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**resource_id:** `str` — The ID of the target resource.
-
-
-
-
-
--
-
-**resource_type:** `WorkspaceResourceType` — Resource type of the target resource.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.share_workspace_resource(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Grants a role on a workspace resource to a user or a group. It overrides any existing role this user/group/workspace api key has on the resource. To target a user, pass only the user email. The user must be in your workspace. To target a group, pass only the group id. To target a workspace api key, pass the api key id. You must have admin access to the resource to share it.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.share_workspace_resource(
- resource_id="resource_id",
- role="admin",
- resource_type="voice",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**resource_id:** `str` — The ID of the target resource.
-
-
-
-
-
--
-
-**role:** `BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePostRole` — Role to update the target principal with.
-
-
-
-
-
--
-
-**resource_type:** `WorkspaceResourceType` — Resource type of the target resource.
-
-
-
-
-
--
-
-**user_email:** `typing.Optional[str]` — The email of the user
-
-
-
-
-
--
-
-**group_id:** `typing.Optional[str]` — The ID of the target group. To target the permissions principals have by default on this resource, use the value 'default'.
-
-
-
-
-
--
-
-**workspace_api_key_id:** `typing.Optional[str]` — The ID of the target workspace API key. This isn't the same as the key itself that would you pass in the header for authentication. Workspace admins can find this in the workspace settings UI.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.workspace.unshare_workspace_resource(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Removes any existing role on a workspace resource from a user or a group. To target a user, pass only the user email. The user must be in your workspace. To target a group, pass only the group id. To target a workspace api key, pass the api key id. You must have admin access to the resource to unshare it. You cannot remove permissions from the user who created the resource.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.workspace.unshare_workspace_resource(
- resource_id="resource_id",
- resource_type="voice",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**resource_id:** `str` — The ID of the target resource.
-
-
-
-
-
--
-
-**resource_type:** `WorkspaceResourceType` — Resource type of the target resource.
-
-
-
-
-
--
-
-**user_email:** `typing.Optional[str]` — The email of the user
-
-
-
-
-
--
-
-**group_id:** `typing.Optional[str]` — The ID of the target group. To target the permissions principals have by default on this resource, use the value 'default'.
-
-
-
-
-
--
-
-**workspace_api_key_id:** `typing.Optional[str]` — The ID of the target workspace API key. This isn't the same as the key itself that would you pass in the header for authentication. Workspace admins can find this in the workspace settings UI.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.speech_to_text.convert(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Transcribe an audio or video file.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.speech_to_text.convert(
- model_id="model_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model_id:** `str` — The ID of the model to use for transcription, currently only 'scribe_v1' is available.
-
-
-
-
-
--
-
-**file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
-
-
-
-
-
--
-
-**enable_logging:** `typing.Optional[bool]` — When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers.
-
-
-
-
-
--
-
-**language_code:** `typing.Optional[str]` — An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file. Can sometimes improve transcription performance if known beforehand. Defaults to null, in this case the language is predicted automatically.
-
-
-
-
-
--
-
-**tag_audio_events:** `typing.Optional[bool]` — Whether to tag audio events like (laughter), (footsteps), etc. in the transcription.
-
-
-
-
-
--
-
-**num_speakers:** `typing.Optional[int]` — The maximum amount of speakers talking in the uploaded file. Can help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32. Defaults to null, in this case the amount of speakers is set to the maximum value the model supports.
-
-
-
-
-
--
-
-**timestamps_granularity:** `typing.Optional[SpeechToTextConvertRequestTimestampsGranularity]` — The granularity of the timestamps in the transcription. 'word' provides word-level timestamps and 'character' provides character-level timestamps per word.
-
-
-
-
-
--
-
-**diarize:** `typing.Optional[bool]` — Whether to annotate which speaker is currently talking in the uploaded file.
-
-
-
-
-
--
-
-**additional_formats:** `typing.Optional[AdditionalFormats]` — A list of additional formats to export the transcript to.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.forced_alignment.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Force align an audio file to text. Use this endpoint to get the timing information for each character and word in an audio file based on a provided text transcript.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.forced_alignment.create(
- text="text",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
-
-
-
-
-
--
-
-**text:** `str` — The text to align with the audio or video. The input text can be in any format, however diarization is not supported at this time.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_signed_url(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a signed url to start a conversation with an agent with an agent that requires authorization
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_signed_url(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of the agent you're taking the action on.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.twilio_outbound_call(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Handle an outbound call via Twilio
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.twilio_outbound_call(
- agent_id="agent_id",
- agent_phone_number_id="agent_phone_number_id",
- to_number="to_number",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str`
-
-
-
-
-
--
-
-**agent_phone_number_id:** `str`
-
-
-
-
-
--
-
-**to_number:** `str`
-
-
-
-
-
--
-
-**conversation_initiation_client_data:** `typing.Optional[ConversationInitiationClientDataRequestInput]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_agent(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create an agent from a config object
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ConversationalConfigApiModelInput, ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_agent(
- conversation_config=ConversationalConfigApiModelInput(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**conversation_config:** `ConversationalConfigApiModelInput` — Conversation configuration for an agent
-
-
-
-
-
--
-
-**use_tool_ids:** `typing.Optional[bool]` — Use tool ids instead of tools specs from request payload.
-
-
-
-
-
--
-
-**platform_settings:** `typing.Optional[AgentPlatformSettingsRequestModel]` — Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — A name to make the agent easier to find
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_agent(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve config for an agent
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_agent(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.delete_agent(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete an agent
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_agent(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.update_agent(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Patches an Agent settings
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.update_agent(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**use_tool_ids:** `typing.Optional[bool]` — Use tool ids instead of tools specs from request payload.
-
-
-
-
-
--
-
-**conversation_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Conversation configuration for an agent
-
-
-
-
-
--
-
-**platform_settings:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — A name to make the agent easier to find
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_agent_widget(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve the widget configuration for an agent
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_agent_widget(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**conversation_signature:** `typing.Optional[str]` — An expiring token that enables a conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_agent_link(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the current link used to share the agent with others
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_agent_link(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.post_agent_avatar(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Sets the avatar for an agent displayed in the widget
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.post_agent_avatar(
- agent_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**avatar_file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_agents(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of your agents and their metadata.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_agents()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many Agents to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**search:** `typing.Optional[str]` — Search by agents name.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_conversations(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all conversations of agents that user owns. With option to restrict to a specific agent.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_conversations()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
-
-
-
-
-
--
-
-**agent_id:** `typing.Optional[str]` — The id of the agent you're taking the action on.
-
-
-
-
-
--
-
-**call_successful:** `typing.Optional[EvaluationSuccessResult]` — The result of the success evaluation
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many conversations to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_conversation(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the details of a particular conversation
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_conversation(
- conversation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**conversation_id:** `str` — The id of the conversation you're taking the action on.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.delete_conversation(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a particular conversation
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_conversation(
- conversation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**conversation_id:** `str` — The id of the conversation you're taking the action on.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.post_conversation_feedback(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Send the feedback for the given conversation
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.post_conversation_feedback(
- conversation_id="21m00Tcm4TlvDq8ikWAM",
- feedback="like",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**conversation_id:** `str` — The id of the conversation you're taking the action on.
-
-
-
-
-
--
-
-**feedback:** `UserFeedbackScore` — Either 'like' or 'dislike' to indicate the feedback for the conversation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_phone_number(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Import Phone Number from provider configuration (Twilio or SIP trunk)
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import CreateTwilioPhoneNumberRequest, ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_phone_number(
- request=CreateTwilioPhoneNumberRequest(
- phone_number="phone_number",
- label="label",
- sid="sid",
- token="token",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `ConversationalAiCreatePhoneNumberRequestBody`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_phone_number(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve Phone Number details by ID
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_phone_number(
- phone_number_id="TeaqRRdTcIfIu2i7BYfT",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**phone_number_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.delete_phone_number(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete Phone Number by ID
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_phone_number(
- phone_number_id="TeaqRRdTcIfIu2i7BYfT",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**phone_number_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.update_phone_number(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update Phone Number details by ID
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.update_phone_number(
- phone_number_id="TeaqRRdTcIfIu2i7BYfT",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**phone_number_id:** `str` — The id of an agent. This is returned on agent creation.
-
-
-
-
-
--
-
-**agent_id:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_phone_numbers()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve all Phone Numbers
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_phone_numbers()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_knowledge_base_list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a list of available knowledge base documents
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_knowledge_base_list()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many documents to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**search:** `typing.Optional[str]` — If specified, the endpoint returns only such knowledge base documents whose names start with this string.
-
-
-
-
-
--
-
-**show_only_owned_documents:** `typing.Optional[bool]` — If set to true, the endpoint will return only documents owned by you (and not shared from somebody else).
-
-
-
-
-
--
-
-**use_typesense:** `typing.Optional[bool]` — If set to true, the endpoint will use typesense DB to search for the documents).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.add_to_knowledge_base(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Uploads a file or reference a webpage to use as part of the shared knowledge base
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.add_to_knowledge_base()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
-
-
-
-
-
--
-
-**url:** `typing.Optional[str]` — URL to a page of documentation that the agent will have access to in order to interact with users.
-
-
-
-
-
--
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_knowledge_base_url_document(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a knowledge base document generated by scraping the given webpage.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_knowledge_base_url_document(
- url="url",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**url:** `str` — URL to a page of documentation that the agent will have access to in order to interact with users.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_knowledge_base_file_document(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a knowledge base document generated form the uploaded file.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_knowledge_base_file_document()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_knowledge_base_text_document(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a knowledge base document containing the provided text.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_knowledge_base_text_document(
- text="text",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**text:** `str` — Text content to be added to the knowledge base.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.rag_index_status(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.rag_index_status(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
- model="e5_mistral_7b_instruct",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**model:** `EmbeddingModelEnum`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_knowledge_base_document_by_id(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get details about a specific documentation making up the agent's knowledge base
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_knowledge_base_document_by_id(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.delete_knowledge_base_document(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a document from the knowledge base
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_knowledge_base_document(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_dependent_agents(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a list of agents depending on this knowledge base document
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_dependent_agents(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — How many documents to return at maximum. Can not exceed 100, defaults to 30.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_knowledge_base_document_content(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the entire content of a document from the knowledge base
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_knowledge_base_document_content(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_knowledge_base_document_part_by_id(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get details about a specific documentation part used by RAG.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_knowledge_base_document_part_by_id(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
- chunk_id="chunk_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
-
-
-
-
-
--
-
-**chunk_id:** `str` — The id of a document RAG chunk from the knowledge base.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_settings()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve Convai settings for the workspace
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_settings()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.update_settings(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update Convai settings for the workspace
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.update_settings()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**conversation_initiation_client_data_webhook:** `typing.Optional[ConversationInitiationClientDataWebhook]`
-
-
-
-
-
--
-
-**webhooks:** `typing.Optional[ConvAiWebhooks]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.get_secrets()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all workspace secrets for the user
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_secrets()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.create_secret(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a new secret for the workspace
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.create_secret(
- name="name",
- value="value",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str`
-
-
-
-
-
--
-
-**value:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.conversational_ai.delete_secret(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a workspace secret if it's not in use
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_secret(
- secret_id="secret_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**secret_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.get_all()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of your Studio projects with metadata.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.get_all()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.add(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new Studio project, it can be either initialized as blank, from a document or from a URL.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.add(
- name="name",
- default_title_voice_id="default_title_voice_id",
- default_paragraph_voice_id="default_paragraph_voice_id",
- default_model_id="default_model_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the Studio project, used for identification only.
-
-
-
-
-
--
-
-**default_title_voice_id:** `str` — The voice_id that corresponds to the default voice used for new titles.
-
-
-
-
-
--
-
-**default_paragraph_voice_id:** `str` — The voice_id that corresponds to the default voice used for new paragraphs.
-
-
-
-
-
--
-
-**default_model_id:** `str` — The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**from_document:** `typing.Optional[str]` — An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**quality_preset:** `typing.Optional[str]`
-
-Output quality of the generated audio. Must be one of:
-standard - standard output format, 128kbps with 44.1kHz sample rate.
-high - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the credit cost by 20%.
-ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the credit cost by 50%.
-ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the credit cost by 100%.
-
-
-
-
-
--
-
-**title:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**author:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — An optional description of the Studio project.
-
-
-
-
-
--
-
-**genres:** `typing.Optional[typing.List[str]]` — An optional list of genres associated with the Studio project.
-
-
-
-
-
--
-
-**target_audience:** `typing.Optional[ProjectsAddRequestTargetAudience]` — An optional target audience of the Studio project.
-
-
-
-
-
--
-
-**language:** `typing.Optional[str]` — An optional language of the Studio project. Two-letter language code (ISO 639-1).
-
-
-
-
-
--
-
-**content_type:** `typing.Optional[str]` — An optional content type of the Studio project.
-
-
-
-
-
--
-
-**original_publication_date:** `typing.Optional[str]` — An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY.
-
-
-
-
-
--
-
-**mature_content:** `typing.Optional[bool]` — An optional specification of whether this Studio project contains mature content.
-
-
-
-
-
--
-
-**isbn_number:** `typing.Optional[str]` — An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**acx_volume_normalization:** `typing.Optional[bool]` — [Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**volume_normalization:** `typing.Optional[bool]` — When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**pronunciation_dictionary_locators:** `typing.Optional[typing.List[str]]` — A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. Note that multiple dictionaries are not currently supported by our UI which will only show the first.
-
-
-
-
-
--
-
-**callback_url:** `typing.Optional[str]` — A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion
-
-
-
-
-
--
-
-**fiction:** `typing.Optional[ProjectsAddRequestFiction]` — An optional specification of whether the content of this Studio project is fiction.
-
-
-
-
-
--
-
-**apply_text_normalization:** `typing.Optional[ProjectsAddRequestApplyTextNormalization]`
-
-
- This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.
- When set to 'auto', the system will automatically decide whether to apply text normalization
- (e.g., spelling out numbers). With 'on', text normalization will always be applied, while
- with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.
-
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the Studio project to audio or not.
-
-
-
-
-
--
-
-**auto_assign_voices:** `typing.Optional[bool]` — [Alpha Feature] Whether automatically assign voices to phrases in the create Project.
-
-
-
-
-
--
-
-**source_type:** `typing.Optional[ProjectsAddRequestSourceType]` — The type of Studio project to create.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.get(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns information about a specific Studio project. This endpoint returns more detailed information about a project than `GET /v1/studio`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.get(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.update_metadata(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the specified Studio project by setting the values of the parameters passed.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.update_metadata(
- project_id="21m00Tcm4TlvDq8ikWAM",
- name="Project 1",
- default_title_voice_id="21m00Tcm4TlvDq8ikWAM",
- default_paragraph_voice_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**name:** `str` — The name of the Studio project, used for identification only.
-
-
-
-
-
--
-
-**default_title_voice_id:** `str` — The voice_id that corresponds to the default voice used for new titles.
-
-
-
-
-
--
-
-**default_paragraph_voice_id:** `str` — The voice_id that corresponds to the default voice used for new paragraphs.
-
-
-
-
-
--
-
-**title:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**author:** `typing.Optional[str]` — An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**isbn_number:** `typing.Optional[str]` — An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.
-
-
-
-
-
--
-
-**volume_normalization:** `typing.Optional[bool]` — When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.delete(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a Studio project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.delete(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.update_content(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates Studio project content.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.update_content(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**from_document:** `typing.Optional[str]` — An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the Studio project to audio or not.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.convert(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Starts conversion of a Studio project and all of its chapters.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.convert(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.get_snapshots(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieves a list of snapshots for a Studio project.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.get_snapshots(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.get_project_snapshot(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the project snapshot.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.get_project_snapshot(
- project_id="21m00Tcm4TlvDq8ikWAM",
- project_snapshot_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**project_snapshot_id:** `str` — The ID of the Studio project snapshot.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.stream_audio(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Stream the audio from a Studio project snapshot.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.stream_audio(
- project_id="21m00Tcm4TlvDq8ikWAM",
- project_snapshot_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**project_snapshot_id:** `str` — The ID of the Studio project snapshot.
-
-
-
-
-
--
-
-**convert_to_mpeg:** `typing.Optional[bool]` — Whether to convert the audio to mpeg format.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.projects.update_pronunciation_dictionaries(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a 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.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs, PronunciationDictionaryVersionLocator
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.projects.update_pronunciation_dictionaries(
- project_id="21m00Tcm4TlvDq8ikWAM",
- pronunciation_dictionary_locators=[
- PronunciationDictionaryVersionLocator(
- pronunciation_dictionary_id="pronunciation_dictionary_id",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**pronunciation_dictionary_locators:** `typing.Sequence[PronunciationDictionaryVersionLocator]` — A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. Note that multiple dictionaries are not currently supported by our UI which will only show the first.
-
-
-
-
-
--
-
-**invalidate_affected_text:** `typing.Optional[bool]` — This will automatically mark text in this project for reconversion when the new dictionary applies or the old one no longer does.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.get_all(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of a Studio project's chapters.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.get_all(
- project_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a new chapter either as blank or from a URL.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.create(
- project_id="21m00Tcm4TlvDq8ikWAM",
- name="Chapter 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**name:** `str` — The name of the chapter, used for identification only.
-
-
-
-
-
--
-
-**from_url:** `typing.Optional[str]` — An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the Studio project as blank.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.get(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns information about a specific chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.get(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.edit(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates a chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.edit(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — The name of the chapter, used for identification only.
-
-
-
-
-
--
-
-**content:** `typing.Optional[ChapterContentInputModel]` — The chapter content to use.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.delete(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes a chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.delete(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.convert(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Starts conversion of a specific chapter.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.convert(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.get_all_snapshots(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets information about all the snapshots of a chapter. Each snapshot can be downloaded as audio. Whenever a chapter is converted a snapshot will automatically be created.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.get_all_snapshots(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.studio.chapters.get_chapter_snapshot(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the chapter snapshot.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.studio.chapters.get_chapter_snapshot(
- project_id="21m00Tcm4TlvDq8ikWAM",
- chapter_id="21m00Tcm4TlvDq8ikWAM",
- chapter_snapshot_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**project_id:** `str` — The ID of the Studio project.
-
-
-
-
-
--
-
-**chapter_id:** `str` — The ID of the chapter.
-
-
-
-
-
--
-
-**chapter_snapshot_id:** `str` — The ID of the chapter snapshot.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-