Implementation:Elevenlabs Elevenlabs python VoiceSharingResponse
| Attribute | Value |
|---|---|
| Sources | src/elevenlabs/types/voice_sharing_response.py
|
| Domains | Voice Sharing, Voice Library, Moderation |
| Last Updated | 2026-02-15 |
Overview
Description
The VoiceSharingResponse model represents the sharing configuration and status of a voice in the ElevenLabs voice library. This is one of the largest type definitions in the SDK (188 lines, 33 fields), capturing sharing state, financial reward settings, moderation status, social media links, library visibility, and usage statistics. It provides a comprehensive view of how a voice is shared with and consumed by other users.
Usage
The VoiceSharingResponse model is primarily used as a nested field within the Voice model (via its sharing attribute). It is populated when voice data is retrieved from the API and the voice has sharing information configured. This model is essential for understanding voice marketplace listings, community sharing permissions, and moderation outcomes.
Code Reference
Source Location
src/elevenlabs/types/voice_sharing_response.py
Class Signature
class VoiceSharingResponse(UncheckedBaseModel):
...
Import Statement
from elevenlabs.types import VoiceSharingResponse
Base Class
UncheckedBaseModel (from elevenlabs.core.unchecked_base_model)
I/O Contract
| Field | Type | Required | Description |
|---|---|---|---|
status |
Optional[VoiceSharingState] |
No | The status of the voice sharing. |
history_item_sample_id |
Optional[str] |
No | The sample ID of the history item. |
date_unix |
Optional[int] |
No | The date of the voice sharing in Unix time. |
whitelisted_emails |
Optional[List[str]] |
No | A list of whitelisted emails. |
public_owner_id |
Optional[str] |
No | The ID of the public owner. |
original_voice_id |
Optional[str] |
No | The ID of the original voice. |
financial_rewards_enabled |
Optional[bool] |
No | Whether financial rewards are enabled. |
free_users_allowed |
Optional[bool] |
No | Whether free users are allowed. |
live_moderation_enabled |
Optional[bool] |
No | Whether live moderation is enabled. |
rate |
Optional[float] |
No | The rate of the voice sharing. |
fiat_rate |
Optional[float] |
No | The rate of the voice sharing in USD per 1000 credits. |
notice_period |
Optional[int] |
No | The notice period of the voice sharing. |
disable_at_unix |
Optional[int] |
No | The date the voice sharing will be disabled in Unix time. |
voice_mixing_allowed |
Optional[bool] |
No | Whether voice mixing is allowed. |
featured |
Optional[bool] |
No | Whether the voice is featured. |
category |
Optional[VoiceSharingResponseModelCategory] |
No | The category of the voice. |
reader_app_enabled |
Optional[bool] |
No | Whether the reader app is enabled. |
image_url |
Optional[str] |
No | The image URL of the voice. |
ban_reason |
Optional[str] |
No | The ban reason of the voice. |
liked_by_count |
Optional[int] |
No | The number of likes on the voice. |
cloned_by_count |
Optional[int] |
No | The number of clones on the voice. |
name |
Optional[str] |
No | The name of the voice. |
description |
Optional[str] |
No | The description of the voice. |
labels |
Optional[Dict[str, str]] |
No | The labels of the voice. |
review_status |
Optional[ReviewStatus] |
No | The review status of the voice. |
review_message |
Optional[str] |
No | The review message of the voice. |
enabled_in_library |
Optional[bool] |
No | Whether the voice is enabled in the library. |
instagram_username |
Optional[str] |
No | The Instagram username of the voice. |
twitter_username |
Optional[str] |
No | The Twitter/X username of the voice. |
youtube_username |
Optional[str] |
No | The YouTube username of the voice. |
tiktok_username |
Optional[str] |
No | The TikTok username of the voice. |
moderation_check |
Optional[VoiceSharingModerationCheckResponseModel] |
No | The moderation check of the voice. |
reader_restricted_on |
Optional[List[ReaderResourceResponseModel]] |
No | The reader restricted on of the voice. |
Usage Examples
from elevenlabs import ElevenLabs
client = ElevenLabs(api_key="your_api_key")
# Access sharing info through a Voice object
voice = client.voices.get(voice_id="voice_abc123")
if voice.sharing:
sharing = voice.sharing
print(f"Sharing status: {sharing.status}")
print(f"Likes: {sharing.liked_by_count}")
print(f"Clones: {sharing.cloned_by_count}")
print(f"Featured: {sharing.featured}")
# Check financial reward configuration
if sharing.financial_rewards_enabled:
print(f"Rate (USD/1000 credits): {sharing.fiat_rate}")
# Review moderation status
if sharing.review_status:
print(f"Review: {sharing.review_status}")
# Check social media links
if sharing.twitter_username:
print(f"Twitter: @{sharing.twitter_username}")
Related Pages
- Voice - Parent model that contains
VoiceSharingResponseas thesharingfield - GetVoicesV2Response - Paginated listing containing voices with sharing data