Skip to content

🌿 Fern Regeneration -- January 19, 2026 #719

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
Jan 19, 2026
Merged

🌿 Fern Regeneration -- January 19, 2026 #719

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.30.0"
version = "v2.31.0"
description = ""
readme = "README.md"
authors = []
Expand Down
202 changes: 184 additions & 18 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@ Defaults to None.
<dl>
<dd>

**output_format:** `typing.Optional[TextToSpeechConvertRequestOutputFormat]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
**output_format:** `typing.Optional[TextToSpeechConvertRequestOutputFormat]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.

</dd>
</dl>
Expand Down Expand Up @@ -929,7 +929,7 @@ client.text_to_speech.convert_with_timestamps(
voice_id="21m00Tcm4TlvDq8ikWAM",
enable_logging=True,
optimize_streaming_latency=1,
output_format="mp3_22050_32",
output_format="alaw_8000",
text="This is a test for the API of ElevenLabs.",
)

Expand Down Expand Up @@ -988,7 +988,7 @@ Defaults to None.
<dl>
<dd>

**output_format:** `typing.Optional[TextToSpeechConvertWithTimestampsRequestOutputFormat]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
**output_format:** `typing.Optional[TextToSpeechConvertWithTimestampsRequestOutputFormat]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.

</dd>
</dl>
Expand Down Expand Up @@ -3502,7 +3502,7 @@ typing.Optional[typing.List[core.File]]` — See core.File for more documentatio
<dl>
<dd>

**labels:** `typing.Optional[str]` — Serialized labels dictionary for the voice.
**labels:** `typing.Optional[VoicesUpdateRequestLabels]` — Labels for the voice. Keys can be language, accent, gender, or age.

</dd>
</dl>
Expand Down Expand Up @@ -4020,10 +4020,10 @@ client.studio.create_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.
ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
'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.
'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.

</dd>
</dl>
Expand Down Expand Up @@ -6132,7 +6132,7 @@ client = ElevenLabs(
)
client.speech_to_text.convert(
enable_logging=True,
model_id="model_id",
model_id="scribe_v1",
)

```
Expand All @@ -6149,7 +6149,7 @@ client.speech_to_text.convert(
<dl>
<dd>

**model_id:** `str` — The ID of the model to use for transcription, currently only 'scribe_v1' and 'scribe_v1_experimental' are available.
**model_id:** `SpeechToTextConvertRequestModelId` — The ID of the model to use for transcription.

</dd>
</dl>
Expand Down Expand Up @@ -7135,6 +7135,7 @@ client = ElevenLabs(
client.conversational_ai.conversations.get_signed_url(
agent_id="21m00Tcm4TlvDq8ikWAM",
include_conversation_id=True,
branch_id="branch_id",
)

```
Expand Down Expand Up @@ -7167,6 +7168,14 @@ client.conversational_ai.conversations.get_signed_url(
<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

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

</dd>
Expand Down Expand Up @@ -7214,6 +7223,7 @@ client = ElevenLabs(
client.conversational_ai.conversations.get_webrtc_token(
agent_id="21m00Tcm4TlvDq8ikWAM",
participant_name="participant_name",
branch_id="branch_id",
)

```
Expand Down Expand Up @@ -7246,6 +7256,14 @@ client.conversational_ai.conversations.get_webrtc_token(
<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

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

</dd>
Expand Down Expand Up @@ -7306,6 +7324,7 @@ client.conversational_ai.conversations.list(
summary_mode="exclude",
search="search",
conversation_initiation_source="unknown",
branch_id="branch_id",
)

```
Expand Down Expand Up @@ -7474,6 +7493,14 @@ client.conversational_ai.conversations.list(
<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Filter conversations by branch ID.

</dd>
</dl>

<dl>
<dd>

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

</dd>
Expand Down Expand Up @@ -11336,6 +11363,76 @@ client.conversational_ai.batch_calls.get(
</dl>


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

<details><summary><code>client.conversational_ai.batch_calls.<a href="src/elevenlabs/conversational_ai/batch_calls/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Permanently delete a batch call and all recipient records. Conversations remain in history.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.batch_calls.delete(
batch_id="batch_id",
)

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**batch_id:** `str`

</dd>
</dl>

<dl>
<dd>

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

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


</dd>
</dl>
</details>
Expand Down Expand Up @@ -12353,6 +12450,75 @@ client.conversational_ai.whatsapp_accounts.update(
</dl>


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

## ConversationalAi Agents Summaries
<details><summary><code>client.conversational_ai.agents.summaries.<a href="src/elevenlabs/conversational_ai/agents/summaries/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns summaries for the specified agents.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from elevenlabs import ElevenLabs

client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.agents.summaries.get()

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**agent_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — List of agent IDs to fetch summaries for

</dd>
</dl>

<dl>
<dd>

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

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


</dd>
</dl>
</details>
Expand Down Expand Up @@ -17474,13 +17640,13 @@ typing.Optional[core.File]` — See core.File for more documentation
<dl>
<dd>

**quality_preset:** `typing.Optional[str]`
**quality_preset:** `typing.Optional[ProjectsCreateRequestQualityPreset]`

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.
ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
'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.
'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.

</dd>
</dl>
Expand Down Expand Up @@ -19855,7 +20021,7 @@ typing.List[core.File]` — See core.File for more documentation
<dl>
<dd>

**labels:** `typing.Optional[str]` — Serialized labels dictionary for the voice.
**labels:** `typing.Optional[IvcCreateRequestLabels]` — Labels for the voice. Keys can be language, accent, gender, or age.

</dd>
</dl>
Expand Down Expand Up @@ -19951,7 +20117,7 @@ client.voices.pvc.create(
<dl>
<dd>

**labels:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]` — Serialized labels dictionary for the voice.
**labels:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]` — Labels for the voice. Keys can be language, accent, gender, or age.

</dd>
</dl>
Expand Down Expand Up @@ -20053,7 +20219,7 @@ client.voices.pvc.update(
<dl>
<dd>

**labels:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]` — Serialized labels dictionary for the voice.
**labels:** `typing.Optional[typing.Dict[str, typing.Optional[str]]]` — Labels for the voice. Keys can be language, accent, gender, or age.

</dd>
</dl>
Expand Down
Loading