Skip to main content
POST
/
v1
/
text-to-voice
/
create-voice-from-preview
Python
from elevenlabs import ElevenLabs

client = ElevenLabs(
    api_key="YOUR_API_KEY",
)
client.text_to_voice.create_voice_from_preview(
    voice_name="Little squeaky mouse",
    voice_description="A sassy little squeaky mouse",
    generated_voice_id="37HceQefKmEi3bGovXjL",
)
{
  "voice_id": "<string>",
  "name": "<string>",
  "samples": [
    {
      "sample_id": "<string>",
      "file_name": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "hash": "<string>"
    }
  ],
  "category": "generated",
  "fine_tuning": {
    "is_allowed_to_fine_tune": true,
    "state": {},
    "verification_failures": [
      "<string>"
    ],
    "verification_attempts_count": 123,
    "manual_verification_requested": true,
    "language": "<string>",
    "progress": {},
    "message": {},
    "dataset_duration_seconds": 123,
    "verification_attempts": [
      {
        "text": "<string>",
        "date_unix": 123,
        "accepted": true,
        "similarity": 123,
        "levenshtein_distance": 123,
        "recording": {
          "recording_id": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123,
          "transcription": "<string>"
        }
      }
    ],
    "slice_ids": [
      "<string>"
    ],
    "manual_verification": {
      "extra_text": "<string>",
      "request_time_unix": 123,
      "files": [
        {
          "file_id": "<string>",
          "file_name": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123
        }
      ]
    },
    "max_verification_attempts": 123,
    "next_max_verification_attempts_reset_unix_ms": 123
  },
  "labels": {},
  "description": "<string>",
  "preview_url": "<string>",
  "available_for_tiers": [
    "<string>"
  ],
  "settings": {
    "stability": 123,
    "similarity_boost": 123,
    "style": 0,
    "use_speaker_boost": true
  },
  "sharing": {
    "status": "enabled",
    "history_item_sample_id": "<string>",
    "date_unix": 123,
    "whitelisted_emails": [
      "<string>"
    ],
    "public_owner_id": "<string>",
    "original_voice_id": "<string>",
    "financial_rewards_enabled": true,
    "free_users_allowed": true,
    "live_moderation_enabled": true,
    "rate": 123,
    "notice_period": 123,
    "disable_at_unix": 123,
    "voice_mixing_allowed": true,
    "featured": true,
    "category": "generated",
    "reader_app_enabled": true,
    "image_url": "<string>",
    "ban_reason": "<string>",
    "liked_by_count": 123,
    "cloned_by_count": 123,
    "name": "<string>",
    "description": "<string>",
    "labels": {},
    "review_status": "not_requested",
    "review_message": "<string>",
    "enabled_in_library": true,
    "instagram_username": "<string>",
    "twitter_username": "<string>",
    "youtube_username": "<string>",
    "tiktok_username": "<string>",
    "moderation_check": {
      "date_checked_unix": 123,
      "name_value": "<string>",
      "name_check": true,
      "description_value": "<string>",
      "description_check": true,
      "sample_ids": [
        "<string>"
      ],
      "sample_checks": [
        123
      ],
      "captcha_ids": [
        "<string>"
      ],
      "captcha_checks": [
        123
      ]
    },
    "reader_restricted_on": [
      {
        "resource_type": "read",
        "resource_id": "<string>"
      }
    ]
  },
  "high_quality_base_model_ids": [
    "<string>"
  ],
  "safety_control": "NONE",
  "voice_verification": {
    "requires_verification": true,
    "is_verified": true,
    "verification_failures": [
      "<string>"
    ],
    "verification_attempts_count": 123,
    "language": "<string>",
    "verification_attempts": [
      {
        "text": "<string>",
        "date_unix": 123,
        "accepted": true,
        "similarity": 123,
        "levenshtein_distance": 123,
        "recording": {
          "recording_id": "<string>",
          "mime_type": "<string>",
          "size_bytes": 123,
          "upload_date_unix": 123,
          "transcription": "<string>"
        }
      }
    ]
  },
  "permission_on_resource": "<string>",
  "is_owner": true,
  "is_legacy": false,
  "is_mixed": false,
  "created_at_unix": 123
}

Headers

​
xi-api-key
string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Body

application/json
​
voice_name
string
required

Name to use for the created voice.

Examples:

"Little squeaky mouse"

​
voice_description
string
required

Description to use for the created voice.

Required string length: 20 - 1000
Examples:

"A sassy little squeaky mouse"

​
generated_voice_id
string
required

The generated_voice_id to create, call POST /v1/voice-generation/generate-voice and fetch the generated_voice_id from the response header if don't have one yet.

Examples:

"37HceQefKmEi3bGovXjL"

​
labels
object

Optional, metadata to add to the created voice. Defaults to None.

Examples:
{ "language": "en" }
​
played_not_selected_voice_ids
string[]

List of voice ids that the user has played but not selected. Used for RLHF.

Response

Successful Response

​
voice_id
string
required
​
name
string
required
​
samples
SampleResponseModel · object[]
required
​
category
enum<string>
required
Available options:
generated,
cloned,
premade,
professional,
famous,
high_quality
​
fine_tuning
object
required
​
labels
object
required
​
description
string
required
​
preview_url
string
required
​
available_for_tiers
string[]
required
​
settings
object
required
​
sharing
object
required
​
high_quality_base_model_ids
string[]
required
​
safety_control
enum<string>
Available options:
NONE,
BAN,
CAPTCHA,
CAPTCHA_AND_MODERATION,
ENTERPRISE_BAN,
ENTERPRISE_CAPTCHA
​
voice_verification
object
​
permission_on_resource
string
​
is_owner
boolean
​
is_legacy
boolean
default:false
​
is_mixed
boolean
default:false
​
created_at_unix
integer