Skip to content

🌿 Fern Regeneration -- March 5, 2026 #740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PaulAsjes merged 1 commit into from
Mar 5, 2026
Merged

🌿 Fern Regeneration -- March 5, 2026 #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dynamic = ["version"]

[tool.poetry]
name = "elevenlabs"
version = "v2.37.0"
version = "v2.38.0"
description = ""
readme = "README.md"
authors = []
Expand Down
241 changes: 236 additions & 5 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6285,7 +6285,7 @@ client = ElevenLabs(
)
client.speech_to_text.convert(
enable_logging=True,
model_id="scribe_v1",
model_id="scribe_v2",
)

```
Expand Down Expand Up @@ -6984,7 +6984,7 @@ client.music.compose()
<dl>
<dd>

**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting API.
**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.

</dd>
</dl>
Expand Down Expand Up @@ -7116,7 +7116,7 @@ client.music.compose_detailed()
<dl>
<dd>

**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting API.
**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.

</dd>
</dl>
Expand Down Expand Up @@ -7256,7 +7256,7 @@ client.music.stream()
<dl>
<dd>

**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting API.
**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.

</dd>
</dl>
Expand All @@ -7272,6 +7272,84 @@ client.music.stream()
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.music.<a href="src/elevenlabs/music/client.py">upload</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.music.upload()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**file:** `from __future__ import annotations

core.File` — See core.File for more documentation

</dd>
</dl>

<dl>
<dd>

**extract_composition_plan:** `typing.Optional[bool]` — Whether to generate and return the composition plan for the uploaded song. If True, the response will include the composition_plan but will increase the latency.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down Expand Up @@ -7923,6 +8001,14 @@ client.conversational_ai.twilio.outbound_call(
<dl>
<dd>

**telephony_call_config:** `typing.Optional[TelephonyCallConfig]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -8326,6 +8412,7 @@ client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.agents.create(
enable_versioning=True,
conversation_config=ConversationalConfig(),
)

Expand All @@ -8351,6 +8438,14 @@ client.conversational_ai.agents.create(
<dl>
<dd>

**enable_versioning:** `typing.Optional[bool]` — Enable versioning for the agent

</dd>
</dl>

<dl>
<dd>

**platform_settings:** `typing.Optional[AgentPlatformSettingsRequestModel]` — Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.

</dd>
Expand Down Expand Up @@ -8595,6 +8690,7 @@ client = ElevenLabs(
)
client.conversational_ai.agents.update(
agent_id="agent_3701k3ttaq12ewp8b7qv5rfyszkz",
enable_versioning_if_not_enabled=True,
branch_id="branch_id",
)

Expand All @@ -8620,6 +8716,14 @@ client.conversational_ai.agents.update(
<dl>
<dd>

**enable_versioning_if_not_enabled:** `typing.Optional[bool]` — Enable versioning for the agent, if not already enabled

</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — The ID of the branch to use

</dd>
Expand Down Expand Up @@ -9662,7 +9766,15 @@ client.conversational_ai.tests.list(
<dl>
<dd>

**include_folders:** `typing.Optional[bool]` — Whether to include folders in the response. Defaults to false.
**types:** `typing.Optional[typing.Union[TestType, typing.Sequence[TestType]]]` — If present, the endpoint will return only tests/folders of the given types.

</dd>
</dl>

<dl>
<dd>

**include_folders:** `typing.Optional[bool]` — Deprecated. Use the `types` query param and include `folder` instead.

</dd>
</dl>
Expand Down Expand Up @@ -11684,6 +11796,14 @@ client.conversational_ai.batch_calls.create(
<dl>
<dd>

**telephony_call_config:** `typing.Optional[TelephonyCallConfig]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -12140,6 +12260,14 @@ client.conversational_ai.sip_trunk.outbound_call(
<dl>
<dd>

**telephony_call_config:** `typing.Optional[TelephonyCallConfig]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -12788,6 +12916,14 @@ client.conversational_ai.whatsapp_accounts.update(
<dl>
<dd>

**enable_messaging:** `typing.Optional[bool]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
Expand Down Expand Up @@ -18871,6 +19007,101 @@ client.music.composition_plan.create(
</details>

## PronunciationDictionaries Rules
<details><summary><code>client.pronunciation_dictionaries.rules.<a href="src/elevenlabs/pronunciation_dictionaries/rules/client.py">set</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replaces all existing rules on the pronunciation dictionary with the provided ones.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs
from elevenlabs.pronunciation_dictionaries.rules import (
BodySetRulesOnThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdSetRulesPostRulesItem_Alias,
)

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.pronunciation_dictionaries.rules.set(
pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
rules=[
BodySetRulesOnThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdSetRulesPostRulesItem_Alias(
string_to_replace="Thailand",
case_sensitive=True,
word_boundaries=True,
alias="tie-land",
)
],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary

</dd>
</dl>

<dl>
<dd>

**rules:** `typing.Sequence[
BodySetRulesOnThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdSetRulesPostRulesItem
]`

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' }

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pronunciation_dictionaries.rules.<a href="src/elevenlabs/pronunciation_dictionaries/rules/client.py">add</a>(...)</code></summary>
<dl>
<dd>
Expand Down
Loading