From 85b7cf3cc3f38bbfd45f5000039619186f582061 Mon Sep 17 00:00:00 2001 From: Alex Holt Date: Thu, 11 Jan 2024 16:02:09 +0000 Subject: [PATCH] Read docs from hosted OpenAPI.json --- mint.json | 1 + openapi.json | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) delete mode 100644 openapi.json diff --git a/mint.json b/mint.json index 1291ca05..1c836bf8 100644 --- a/mint.json +++ b/mint.json @@ -175,6 +175,7 @@ "mode": "show" } }, + "openapi": "https://api.elevenlabs.io/openapi.json", "footerSocials": { "linkedin": "https://www.linkedin.com/company/elevenlabsio", "twitter": "https://twitter.com/elevenlabsio", diff --git a/openapi.json b/openapi.json deleted file mode 100644 index 90c22545..00000000 --- a/openapi.json +++ /dev/null @@ -1 +0,0 @@ -{"openapi":"3.1.0","info":{"title":"ElevenLabs API Documentation","description":"This is the documentation for the ElevenLabs API. You can use this API to use our service programmatically, this is done by using your xi-api-key.
You can view your xi-api-key using the 'Profile' tab on https://elevenlabs.io. Our API is experimental so all endpoints are subject to change.","version":"1.0"},"paths":{"/v1/history":{"get":{"tags":["history"],"summary":"Get Generated Items","description":"Returns metadata about all your generated audio.","operationId":"Get_generated_items_v1_history_get","parameters":[{"description":"How many history items to return at maximum. Can not exceed 1000, defaults to 100.","required":false,"schema":{"type":"integer","title":"Page Size","description":"How many history items to return at maximum. Can not exceed 1000, defaults to 100.","default":100},"name":"page_size","in":"query"},{"description":"After which history_item_id to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date.","required":false,"schema":{"type":"string","title":"Start After History Item Id","description":"After which history_item_id to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date."},"name":"start_after_history_item_id","in":"query"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHistoryResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/history/{history_item_id}":{"get":{"tags":["history"],"summary":"Get History Item By Id","description":"Returns information about an history item by its ID.","operationId":"Get_history_item_by_ID_v1_history__history_item_id__get","parameters":[{"description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.","required":true,"schema":{"type":"string","title":"History Item Id","description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs."},"example":"VW7YKqPnjY4h39yTbx2L","name":"history_item_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistoryItemResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["history"],"summary":"Delete History Item","description":"Delete a history item by its ID","operationId":"Delete_history_item_v1_history__history_item_id__delete","parameters":[{"description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.","required":true,"schema":{"type":"string","title":"History Item Id","description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs."},"example":"VW7YKqPnjY4h39yTbx2L","name":"history_item_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/history/{history_item_id}/audio":{"get":{"tags":["history"],"summary":"Get Audio From History Item","description":"Returns the audio of an history item.","operationId":"Get_audio_from_history_item_v1_history__history_item_id__audio_get","parameters":[{"description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.","required":true,"schema":{"type":"string","title":"History Item Id","description":"History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs."},"example":"VW7YKqPnjY4h39yTbx2L","name":"history_item_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"audio/mpeg":{}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/history/download":{"post":{"tags":["history"],"summary":"Download History Items","description":"Download one or more history items. If one history item ID is provided, we will return a single audio file. If more than one history item IDs are provided, we will provide the history items packed into a .zip file.","operationId":"Download_history_items_v1_history_download_post","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_Download_history_items_v1_history_download_post"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/{voice_id}/samples/{sample_id}":{"delete":{"tags":["samples"],"summary":"Delete Sample","description":"Removes a sample by its ID.","operationId":"Delete_sample_v1_voices__voice_id__samples__sample_id__delete","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.","required":true,"schema":{"type":"string","title":"Sample Id","description":"Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice."},"example":"VW7YKqPnjY4h39yTbx2L","name":"sample_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/{voice_id}/samples/{sample_id}/audio":{"get":{"tags":["samples"],"summary":"Get Audio From Sample","description":"Returns the audio corresponding to a sample attached to a voice.","operationId":"Get_audio_from_sample_v1_voices__voice_id__samples__sample_id__audio_get","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice.","required":true,"schema":{"type":"string","title":"Sample Id","description":"Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice."},"example":"VW7YKqPnjY4h39yTbx2L","name":"sample_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"audio/*":{}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/text-to-speech/{voice_id}":{"post":{"tags":["text-to-speech"],"summary":"Text To Speech","description":"Converts text into speech using a voice of your choice and returns audio.","operationId":"Text_to_speech_v1_text_to_speech__voice_id__post","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values:\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (about 50% of possible latency improvement of option 3)\n2 - strong latency optimizations (about 75% of possible latency improvement of option 3)\n3 - max latency optimizations\n4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).\n\nDefaults to 0.\n","required":false,"schema":{"type":"integer","title":"How much we should optimize streaming request latency (time to first audio byte).","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values:\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (about 50% of possible latency improvement of option 3)\n2 - strong latency optimizations (about 75% of possible latency improvement of option 3)\n3 - max latency optimizations\n4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).\n\nDefaults to 0.\n","default":0},"name":"optimize_streaming_latency","in":"query"},{"description":"Output format of the generated audio. Must be one of:\nmp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps.\nmp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps.\nmp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps.\nmp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above.\npcm_16000 - PCM format (S16LE) with 16kHz sample rate.\npcm_22050 - PCM format (S16LE) with 22.05kHz sample rate.\npcm_24000 - PCM format (S16LE) with 24kHz sample rate.\npcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Independent Publisher tier or above.\nulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.\n","required":false,"schema":{"type":"string","title":"Output format of the generated audio.","description":"Output format of the generated audio. Must be one of:\nmp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps.\nmp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps.\nmp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps.\nmp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above.\npcm_16000 - PCM format (S16LE) with 16kHz sample rate.\npcm_22050 - PCM format (S16LE) with 22.05kHz sample rate.\npcm_24000 - PCM format (S16LE) with 24kHz sample rate.\npcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Independent Publisher tier or above.\nulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.\n","default":"mp3_44100_128"},"name":"output_format","in":"query"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_Text_to_speech_v1_text_to_speech__voice_id__post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"audio/mpeg":{}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/text-to-speech/{voice_id}/stream":{"post":{"tags":["text-to-speech"],"summary":"Text To Speech","description":"Converts text into speech using a voice of your choice and returns audio as an audio stream.","operationId":"Text_to_speech_v1_text_to_speech__voice_id__stream_post","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values:\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (about 50% of possible latency improvement of option 3)\n2 - strong latency optimizations (about 75% of possible latency improvement of option 3)\n3 - max latency optimizations\n4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).\n\nDefaults to 0.\n","required":false,"schema":{"type":"integer","title":"How much we should optimize streaming request latency (time to first audio byte).","description":"You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values:\n0 - default mode (no latency optimizations)\n1 - normal latency optimizations (about 50% of possible latency improvement of option 3)\n2 - strong latency optimizations (about 75% of possible latency improvement of option 3)\n3 - max latency optimizations\n4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates).\n\nDefaults to 0.\n","default":0},"name":"optimize_streaming_latency","in":"query"},{"description":"Output format of the generated audio. Must be one of:\nmp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps.\nmp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps.\nmp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps.\nmp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above.\npcm_16000 - PCM format (S16LE) with 16kHz sample rate.\npcm_22050 - PCM format (S16LE) with 22.05kHz sample rate.\npcm_24000 - PCM format (S16LE) with 24kHz sample rate.\npcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Independent Publisher tier or above.\nulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.\n","required":false,"schema":{"type":"string","title":"Output format of the generated audio.","description":"Output format of the generated audio. Must be one of:\nmp3_44100_64 - output format, mp3 with 44.1kHz sample rate at 64kbps.\nmp3_44100_96 - output format, mp3 with 44.1kHz sample rate at 96kbps.\nmp3_44100_128 - default output format, mp3 with 44.1kHz sample rate at 128kbps.\nmp3_44100_192 - output format, mp3 with 44.1kHz sample rate at 192kbps. Requires you to be subscribed to Creator tier or above.\npcm_16000 - PCM format (S16LE) with 16kHz sample rate.\npcm_22050 - PCM format (S16LE) with 22.05kHz sample rate.\npcm_24000 - PCM format (S16LE) with 24kHz sample rate.\npcm_44100 - PCM format (S16LE) with 44.1kHz sample rate. Requires you to be subscribed to Independent Publisher tier or above.\nulaw_8000 - μ-law format (sometimes written mu-law, often approximated as u-law) with 8kHz sample rate. Note that this format is commonly used for Twilio audio inputs.\n","default":"mp3_44100_128"},"name":"output_format","in":"query"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_Text_to_speech_v1_text_to_speech__voice_id__stream_post"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/user/subscription":{"get":{"tags":["user"],"summary":"Get User Subscription Info","description":"Gets extended information about the users subscription","operationId":"Get_user_subscription_info_v1_user_subscription_get","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedSubscriptionResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/user":{"get":{"tags":["user"],"summary":"Get User Info","description":"Gets information about the user","operationId":"Get_user_info_v1_user_get","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices":{"get":{"tags":["voices"],"summary":"Get Voices","description":"Gets a list of all available voices for a user.","operationId":"Get_voices_v1_voices_get","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVoicesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/settings/default":{"get":{"tags":["voices"],"summary":"Get Default Voice Settings.","description":"Gets the default settings for voices. \"similarity_boost\" corresponds to\"Clarity + Similarity Enhancement\" in the web app and \"stability\" corresponds to \"Stability\" slider in the web app.","operationId":"Get_default_voice_settings__v1_voices_settings_default_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceSettingsResponseModel"}}}}}}},"/v1/voices/{voice_id}/settings":{"get":{"tags":["voices"],"summary":"Get Voice Settings","description":"Returns the settings for a specific voice. \"similarity_boost\" corresponds to\"Clarity + Similarity Enhancement\" in the web app and \"stability\" corresponds to \"Stability\" slider in the web app.","operationId":"Get_voice_settings_v1_voices__voice_id__settings_get","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceSettingsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/{voice_id}":{"get":{"tags":["voices"],"summary":"Get Voice","description":"Returns metadata about a specific voice.","operationId":"Get_voice_v1_voices__voice_id__get","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"If set will return settings information corresponding to the voice, requires authorization.","required":false,"schema":{"type":"boolean","title":"With Settings","description":"If set will return settings information corresponding to the voice, requires authorization.","default":false},"name":"with_settings","in":"query"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["voices"],"summary":"Delete Voice","description":"Deletes a voice by its ID.","operationId":"Delete_voice_v1_voices__voice_id__delete","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/{voice_id}/settings/edit":{"post":{"tags":["voices"],"summary":"Edit Voice Settings","description":"Edit your settings for a specific voice. \"similarity_boost\" corresponds to\"Clarity + Similarity Enhancement\" in the web app and \"stability\" corresponds to \"Stability\" slider in the web app.","operationId":"Edit_voice_settings_v1_voices__voice_id__settings_edit_post","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VoiceSettingsResponseModel"}],"title":"Settings","description":"The settings for a specific voice."}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/add":{"post":{"tags":["voices"],"summary":"Add Voice","description":"Add a new voice to your collection of voices in VoiceLab.","operationId":"Add_voice_v1_voices_add_post","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Add_voice_v1_voices_add_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVoiceResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/voices/{voice_id}/edit":{"post":{"tags":["voices"],"summary":"Edit Voice","description":"Edit a voice created by you.","operationId":"Edit_voice_v1_voices__voice_id__edit_post","parameters":[{"description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.","required":true,"schema":{"type":"string","title":"Voice Id","description":"Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices."},"example":"21m00Tcm4TlvDq8ikWAM","name":"voice_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Edit_voice_v1_voices__voice_id__edit_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects":{"get":{"tags":["projects"],"summary":"Get Projects","description":"Returns a list of your projects together and its metadata.","operationId":"Get_projects_v1_projects_get","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/add":{"post":{"tags":["projects"],"summary":"Add Project","description":"Creates a new project, it can be either initialized as blank, from a document or from a URL.","operationId":"Add_project_v1_projects_add_post","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Add_project_v1_projects_add_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProjectResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}":{"get":{"tags":["projects"],"summary":"Get Project By Id","description":"Returns information about a specific project. This endpoint returns more detailed information about a project than GET api.elevenlabs.io/v1/projects.","operationId":"Get_project_by_ID_v1_projects__project_id__get","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectExtendedResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["projects"],"summary":"Delete Project","description":"Delete a project by its project_id.","operationId":"Delete_project_v1_projects__project_id__delete","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/convert":{"post":{"tags":["projects"],"summary":"Convert Project","description":"Starts conversion of a project and all of its chapters.","operationId":"Convert_project_v1_projects__project_id__convert_post","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/snapshots":{"get":{"tags":["projects"],"summary":"Get Project Snapshots","description":"Gets the snapshots of a project.","operationId":"Get_project_snapshots_v1_projects__project_id__snapshots_get","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSnapshotsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/snapshots/{project_snapshot_id}/stream":{"post":{"tags":["projects"],"summary":"Stream Project Audio","description":"Stream the audio from a project snapshot.","operationId":"Stream_project_audio_v1_projects__project_id__snapshots__project_snapshot_id__stream_post","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The project_snapshot_id of the project snapshot. You can query GET /v1/projects/{project_id}/snapshots to list all available snapshots for a project.","required":true,"schema":{"type":"string","title":"Project Snapshot Id","description":"The project_snapshot_id of the project snapshot. You can query GET /v1/projects/{project_id}/snapshots to list all available snapshots for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_snapshot_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/chapters":{"get":{"tags":["projects"],"summary":"Get Chapters","description":"Returns a list of your chapters for a project together and its metadata.","operationId":"Get_chapters_v1_projects__project_id__chapters_get","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChaptersResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}":{"get":{"tags":["projects"],"summary":"Get Chapter By Id","description":"Returns information about a specific chapter.","operationId":"Get_chapter_by_ID_v1_projects__project_id__chapters__chapter_id__get","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.","required":true,"schema":{"type":"string","title":"Chapter Id","description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChapterResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["projects"],"summary":"Delete Chapter","description":"Delete a chapter by its chapter_id.","operationId":"Delete_chapter_v1_projects__project_id__chapters__chapter_id__delete","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.","required":true,"schema":{"type":"string","title":"Chapter Id","description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}/convert":{"post":{"tags":["projects"],"summary":"Convert Chapter","description":"Starts conversion of a specific chapter.","operationId":"Convert_chapter_v1_projects__project_id__chapters__chapter_id__convert_post","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.","required":true,"schema":{"type":"string","title":"Chapter Id","description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}/snapshots":{"get":{"tags":["projects"],"summary":"Get Chapter Snapshots","description":"Gets information about all the snapshots of a chapter, each snapshot corresponds can be downloaded as audio. Whenever a chapter is converted a snapshot will be automatically created.","operationId":"Get_chapter_snapshots_v1_projects__project_id__chapters__chapter_id__snapshots_get","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.","required":true,"schema":{"type":"string","title":"Chapter Id","description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChapterSnapshotsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream":{"post":{"tags":["projects"],"summary":"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.","operationId":"Stream_chapter_audio_v1_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project.","required":true,"schema":{"type":"string","title":"Chapter Id","description":"The chapter_id of the chapter. You can query GET https://api.elevenlabs.io/v1/projects/{project_id}/chapters to list all available chapters for a project."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_id","in":"path"},{"description":"The chapter_snapshot_id of the chapter snapshot. You can query GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots to the all available snapshots for a chapter.","required":true,"schema":{"type":"string","title":"Chapter Snapshot Id","description":"The chapter_snapshot_id of the chapter snapshot. You can query GET /v1/projects/{project_id}/chapters/{chapter_id}/snapshots to the all available snapshots for a chapter."},"example":"21m00Tcm4TlvDq8ikWAM","name":"chapter_snapshot_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects/{project_id}/update-pronunciation-dictionaries":{"post":{"tags":["projects"],"summary":"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.","operationId":"Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post","parameters":[{"description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.","required":true,"schema":{"type":"string","title":"Project Id","description":"The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects."},"example":"21m00Tcm4TlvDq8ikWAM","name":"project_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models":{"get":{"tags":["models"],"summary":"Get Models","description":"Gets a list of available models.","operationId":"Get_Models_v1_models_get","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ModelResponseModel"},"type":"array","title":"Response Get Models V1 Models Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/audio-native":{"post":{"tags":["audio-native"],"summary":"Creates Audionative Enabled Project.","description":"Creates AudioNative enabled project, optionally starts conversion and returns project id and embeddable html snippet.","operationId":"Creates_AudioNative_enabled_project__v1_audio_native_post","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Creates_AudioNative_enabled_project__v1_audio_native_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudioNativeCreateProjectResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pronunciation-dictionaries/add-from-file":{"post":{"tags":["Pronunciation Dictionary"],"summary":"Add A Pronunciation Dictionary","description":"Creates a new pronunciation dictionary from a lexicon .PLS file","operationId":"Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post","parameters":[{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPronunciationDictionaryResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}/":{"get":{"tags":["Pronunciation Dictionary"],"summary":"Get Metadata For A Pronunciation Dictionary","description":"Get metadata for a pronunciation dictionary","operationId":"Get_metadata_for_a_pronunciation_dictionary_v1_pronunciation_dictionaries__pronunciation_dictionary_id___get","parameters":[{"description":"The id of the pronunciation dictionary","required":true,"schema":{"type":"string","title":"Pronunciation Dictionary Id","description":"The id of the pronunciation dictionary"},"example":"21m00Tcm4TlvDq8ikWAM","name":"pronunciation_dictionary_id","in":"path"},{"description":"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.","required":false,"schema":{"type":"string","title":"Xi-Api-Key","description":"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."},"name":"xi-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPronunciationDictionaryMetadataResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/docs":{"get":{"summary":"Redirect To Mintlify","operationId":"redirect_to_mintlify_docs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AddProjectResponseModel":{"properties":{"project":{"$ref":"#/components/schemas/ProjectResponseModel"}},"type":"object","required":["project"],"title":"AddProjectResponseModel"},"AddPronunciationDictionaryResponseModel":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"created_by":{"type":"string","title":"Created By"},"creation_time_unix":{"type":"integer","title":"Creation Time Unix"},"version_id":{"type":"string","title":"Version Id"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","created_by","creation_time_unix","version_id"],"title":"AddPronunciationDictionaryResponseModel"},"AddVoiceResponseModel":{"properties":{"voice_id":{"type":"string","title":"Voice Id"}},"type":"object","required":["voice_id"],"title":"AddVoiceResponseModel"},"AudioNativeCreateProjectResponseModel":{"properties":{"project_id":{"type":"string","title":"Project Id"},"converting":{"type":"boolean","title":"Converting"},"html_snippet":{"type":"string","title":"Html Snippet"}},"type":"object","required":["project_id","converting","html_snippet"],"title":"AudioNativeCreateProjectResponseModel"},"Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"A lexicon .pls file which we will use to initialize the project with."},"name":{"type":"string","title":"Name","description":"The name of the pronunciation dictionary, used for identification only."},"description":{"type":"string","title":"Description","description":"A description of the pronunciation dictionary, used for identification only."}},"type":"object","required":["name"],"title":"Body_Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post"},"Body_Add_project_v1_projects_add_post":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the project, used for identification only."},"from_url":{"type":"string","title":"From Url","description":"An optional URL from which we will extract content to initialize the project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the project as blank."},"from_document":{"type":"string","format":"binary","title":"From Document","description":"An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the 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 project as blank."},"default_title_voice_id":{"type":"string","title":"Default Title Voice Id","description":"The voice_id that corresponds to the default voice used for new titles."},"default_paragraph_voice_id":{"type":"string","title":"Default Paragraph Voice Id","description":"The voice_id that corresponds to the default voice used for new paragraphs."},"default_model_id":{"type":"string","title":"Default Model Id","description":"The model_id of the model to be used for this project, you can query GET https://api.elevenlabs.io/v1/models to list all available models."},"quality_preset":{"type":"string","title":"Quality of the generated audio.","description":"Output quality of the generated audio. Must be one of:\nstandard - standard output format, 128kbps with 44.1kHz sample rate.\nhigh - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. Using this setting increases the character cost by 20%.\nultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the character cost by 50%.\n","default":"standard","include_in_schema":true},"title":{"type":"string","title":"Title","description":"An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."},"author":{"type":"string","title":"Author","description":"An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download."},"isbn_number":{"type":"string","title":"Isbn Number","description":"An optional ISBN number of the project you want to create, this will be added as metadata to the mp3 file on project / chapter download."},"acx_volume_normalization":{"type":"boolean","title":"Acx Volume Normalization","description":"When the project is downloaded, should the returned audio have postprocessing in order to make it compliant with ACX loudness requirements","default":false},"pronunciation_dictionary_locators":{"items":{"type":"string"},"type":"array","title":"Pronunciation Dictionary Locators","description":"A list of pronunciation dictionary locators (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"}},"type":"object","required":["name","default_title_voice_id","default_paragraph_voice_id","default_model_id","pronunciation_dictionary_locators"],"title":"Body_Add_project_v1_projects_add_post"},"Body_Add_voice_v1_voices_add_post":{"properties":{"name":{"type":"string","title":"Name","description":"The name that identifies this voice. This will be displayed in the dropdown of the website."},"files":{"items":{"type":"string","format":"binary"},"type":"array","title":"Files","description":"One or more audio files to clone the voice from"},"description":{"type":"string","title":"Description","description":"How would you describe the voice?"},"labels":{"type":"string","title":"Labels","description":"Serialized labels dictionary for the voice."}},"type":"object","required":["name","files"],"title":"Body_Add_voice_v1_voices_add_post"},"Body_Creates_AudioNative_enabled_project__v1_audio_native_post":{"properties":{"name":{"type":"string","title":"Name","description":"Project name."},"image":{"type":"string","title":"Image","description":"Image URL used in the player. If not provided, default image set in the Player settings is used."},"author":{"type":"string","title":"Author","description":"Author used in the player. If not provided, default author set in the Player settings is used."},"small":{"type":"boolean","title":"Small","description":"Whether to use small player or not. If not provided, default value set in the Player settings is used.","default":false},"text_color":{"type":"string","title":"Text Color","description":"Text color used in the player. If not provided, default text color set in the Player settings is used."},"background_color":{"type":"string","title":"Background Color","description":"Background color used in the player. If not provided, default background color set in the Player settings is used."},"sessionization":{"type":"integer","title":"Sessionization","description":"Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used.","default":0},"voice_id":{"type":"string","title":"Voice Id","description":"Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used."},"model_id":{"type":"string","title":"Model Id","description":"TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used."},"file":{"type":"string","format":"binary","title":"File","description":"HTML input file with a specific format."},"auto_convert":{"type":"boolean","title":"Auto Convert","description":"Whether to auto convert the project to audio or not.","default":false}},"type":"object","required":["name","file"],"title":"Body_Creates_AudioNative_enabled_project__v1_audio_native_post"},"Body_Download_history_items_v1_history_download_post":{"properties":{"history_item_ids":{"items":{"type":"string"},"type":"array","title":"History Item Ids","description":"A list of history items to download, you can get IDs of history items and other metadata using the GET https://api.elevenlabs.io/v1/history endpoint."}},"type":"object","required":["history_item_ids"],"title":"Body_Download_history_items_v1_history_download_post"},"Body_Edit_voice_v1_voices__voice_id__edit_post":{"properties":{"name":{"type":"string","title":"Name","description":"The name that identifies this voice. This will be displayed in the dropdown of the website."},"files":{"items":{"type":"string","format":"binary"},"type":"array","title":"Files","description":"Audio files to add to the voice"},"description":{"type":"string","title":"Description","description":"How would you describe the voice?"},"labels":{"type":"string","title":"Labels","description":"Serialized labels dictionary for the voice."}},"type":"object","required":["name"],"title":"Body_Edit_voice_v1_voices__voice_id__edit_post"},"Body_Text_to_speech_v1_text_to_speech__voice_id__post":{"properties":{"text":{"type":"string","title":"Text","description":"The text that will get converted into speech."},"model_id":{"type":"string","title":"Model Id","description":"Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property.","default":"eleven_monolingual_v1"},"voice_settings":{"allOf":[{"$ref":"#/components/schemas/VoiceSettingsResponseModel"}],"title":"Voice Settings","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given request."}},"type":"object","required":["text"],"title":"Body_Text_to_speech_v1_text_to_speech__voice_id__post"},"Body_Text_to_speech_v1_text_to_speech__voice_id__stream_post":{"properties":{"text":{"type":"string","title":"Text","description":"The text that will get converted into speech."},"model_id":{"type":"string","title":"Model Id","description":"Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property.","default":"eleven_monolingual_v1"},"voice_settings":{"allOf":[{"$ref":"#/components/schemas/VoiceSettingsResponseModel"}],"title":"Voice Settings","description":"Voice settings overriding stored setttings for the given voice. They are applied only on the given request."}},"type":"object","required":["text"],"title":"Body_Text_to_speech_v1_text_to_speech__voice_id__stream_post"},"Body_Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post":{"properties":{"pronunciation_dictionary_locators":{"items":{"$ref":"#/components/schemas/PronunciationDictionaryVersionLocatorDBModel"},"type":"array","title":"Pronunciation Dictionary Locators","description":"A list of pronunciation dictionary locators (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"}},"type":"object","required":["pronunciation_dictionary_locators"],"title":"Body_Update_Pronunciation_Dictionaries_v1_projects__project_id__update_pronunciation_dictionaries_post"},"ChapterResponseModel":{"properties":{"chapter_id":{"type":"string","title":"Chapter Id"},"name":{"type":"string","title":"Name"},"last_conversion_date_unix":{"type":"integer","title":"Last Conversion Date Unix"},"conversion_progress":{"type":"number","title":"Conversion Progress"},"can_be_downloaded":{"type":"boolean","title":"Can Be Downloaded"},"state":{"type":"string","enum":["default","converting"],"title":"State"},"statistics":{"$ref":"#/components/schemas/ChapterStatisticsResponseModel"}},"type":"object","required":["chapter_id","name","last_conversion_date_unix","conversion_progress","can_be_downloaded","state","statistics"],"title":"ChapterResponseModel"},"ChapterSnapshotResponseModel":{"properties":{"chapter_snapshot_id":{"type":"string","title":"Chapter Snapshot Id"},"project_id":{"type":"string","title":"Project Id"},"chapter_id":{"type":"string","title":"Chapter Id"},"created_at_unix":{"type":"integer","title":"Created At Unix"},"name":{"type":"string","title":"Name"}},"type":"object","required":["chapter_snapshot_id","project_id","chapter_id","created_at_unix","name"],"title":"ChapterSnapshotResponseModel"},"ChapterSnapshotsResponseModel":{"properties":{"snapshots":{"items":{"$ref":"#/components/schemas/ChapterSnapshotResponseModel"},"type":"array","title":"Snapshots"}},"type":"object","required":["snapshots"],"title":"ChapterSnapshotsResponseModel"},"ChapterStatisticsResponseModel":{"properties":{"characters_unconverted":{"type":"integer","title":"Characters Unconverted"},"characters_converted":{"type":"integer","title":"Characters Converted"},"paragraphs_converted":{"type":"integer","title":"Paragraphs Converted"},"paragraphs_unconverted":{"type":"integer","title":"Paragraphs Unconverted"}},"type":"object","required":["characters_unconverted","characters_converted","paragraphs_converted","paragraphs_unconverted"],"title":"ChapterStatisticsResponseModel"},"ExtendedSubscriptionResponseModel":{"properties":{"tier":{"type":"string","title":"Tier"},"character_count":{"type":"integer","title":"Character Count"},"character_limit":{"type":"integer","title":"Character Limit"},"can_extend_character_limit":{"type":"boolean","title":"Can Extend Character Limit"},"allowed_to_extend_character_limit":{"type":"boolean","title":"Allowed To Extend Character Limit"},"next_character_count_reset_unix":{"type":"integer","title":"Next Character Count Reset Unix"},"voice_limit":{"type":"integer","title":"Voice Limit"},"max_voice_add_edits":{"type":"integer","title":"Max Voice Add Edits"},"voice_add_edit_counter":{"type":"integer","title":"Voice Add Edit Counter"},"professional_voice_limit":{"type":"integer","title":"Professional Voice Limit"},"can_extend_voice_limit":{"type":"boolean","title":"Can Extend Voice Limit"},"can_use_instant_voice_cloning":{"type":"boolean","title":"Can Use Instant Voice Cloning"},"can_use_professional_voice_cloning":{"type":"boolean","title":"Can Use Professional Voice Cloning"},"currency":{"type":"string","enum":["usd","eur"],"title":"Currency"},"status":{"type":"string","enum":["trialing","active","incomplete","incomplete_expired","past_due","canceled","unpaid","free"],"title":"Status"},"next_invoice":{"$ref":"#/components/schemas/InvoiceResponseModel"},"has_open_invoices":{"type":"boolean","title":"Has Open Invoices"}},"type":"object","required":["tier","character_count","character_limit","can_extend_character_limit","allowed_to_extend_character_limit","next_character_count_reset_unix","voice_limit","max_voice_add_edits","voice_add_edit_counter","professional_voice_limit","can_extend_voice_limit","can_use_instant_voice_cloning","can_use_professional_voice_cloning","currency","status","next_invoice","has_open_invoices"],"title":"ExtendedSubscriptionResponseModel"},"FeedbackResponseModel":{"properties":{"thumbs_up":{"type":"boolean","title":"Thumbs Up"},"feedback":{"type":"string","title":"Feedback"},"emotions":{"type":"boolean","title":"Emotions"},"inaccurate_clone":{"type":"boolean","title":"Inaccurate Clone"},"glitches":{"type":"boolean","title":"Glitches"},"audio_quality":{"type":"boolean","title":"Audio Quality"},"other":{"type":"boolean","title":"Other"},"review_status":{"type":"string","title":"Review Status","default":"not_reviewed"}},"type":"object","required":["thumbs_up","feedback","emotions","inaccurate_clone","glitches","audio_quality","other"],"title":"FeedbackResponseModel"},"FineTuningResponseModel":{"properties":{"language":{"type":"string","title":"Language"},"is_allowed_to_fine_tune":{"type":"boolean","title":"Is Allowed To Fine Tune"},"fine_tuning_requested":{"type":"boolean","title":"Fine Tuning Requested"},"finetuning_state":{"type":"string","enum":["not_started","is_fine_tuning","fine_tuned"],"title":"Finetuning State"},"verification_attempts":{"items":{"$ref":"#/components/schemas/VerificationAttemptResponseModel"},"type":"array","title":"Verification Attempts"},"verification_failures":{"items":{"type":"string"},"type":"array","title":"Verification Failures"},"verification_attempts_count":{"type":"integer","title":"Verification Attempts Count"},"slice_ids":{"items":{"type":"string"},"type":"array","title":"Slice Ids"},"manual_verification":{"$ref":"#/components/schemas/ManualVerificationResponseModel"},"manual_verification_requested":{"type":"boolean","title":"Manual Verification Requested"}},"type":"object","required":["language","is_allowed_to_fine_tune","fine_tuning_requested","finetuning_state","verification_attempts","verification_failures","verification_attempts_count","slice_ids","manual_verification","manual_verification_requested"],"title":"FineTuningResponseModel"},"GetChaptersResponseModel":{"properties":{"chapters":{"items":{"$ref":"#/components/schemas/ChapterResponseModel"},"type":"array","title":"Chapters"}},"type":"object","required":["chapters"],"title":"GetChaptersResponseModel"},"GetHistoryResponseModel":{"properties":{"history":{"items":{"$ref":"#/components/schemas/HistoryItemResponseModel"},"type":"array","title":"History"},"last_history_item_id":{"type":"string","title":"Last History Item Id"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["history","last_history_item_id","has_more"],"title":"GetHistoryResponseModel"},"GetProjectsResponseModel":{"properties":{"projects":{"items":{"$ref":"#/components/schemas/ProjectResponseModel"},"type":"array","title":"Projects"}},"type":"object","required":["projects"],"title":"GetProjectsResponseModel"},"GetPronunciationDictionaryMetadataResponseModel":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"created_by":{"type":"string","title":"Created By"},"creation_time_unix":{"type":"integer","title":"Creation Time Unix"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","created_by","creation_time_unix"],"title":"GetPronunciationDictionaryMetadataResponseModel"},"GetVoicesResponseModel":{"properties":{"voices":{"items":{"$ref":"#/components/schemas/VoiceResponseModel"},"type":"array","title":"Voices"}},"type":"object","required":["voices"],"title":"GetVoicesResponseModel"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HistoryItemResponseModel":{"properties":{"history_item_id":{"type":"string","title":"History Item Id"},"request_id":{"type":"string","title":"Request Id"},"voice_id":{"type":"string","title":"Voice Id"},"model_id":{"type":"string","title":"Model Id"},"voice_name":{"type":"string","title":"Voice Name"},"voice_category":{"type":"string","enum":["premade","cloned","generated","professional"],"title":"Voice Category"},"text":{"type":"string","title":"Text"},"date_unix":{"type":"integer","title":"Date Unix"},"character_count_change_from":{"type":"integer","title":"Character Count Change From"},"character_count_change_to":{"type":"integer","title":"Character Count Change To"},"content_type":{"type":"string","title":"Content Type"},"state":{"type":"string","enum":["created","deleted","processing"],"title":"State"},"settings":{"type":"object","title":"Settings"},"feedback":{"$ref":"#/components/schemas/FeedbackResponseModel"}},"type":"object","required":["history_item_id","request_id","voice_id","model_id","voice_name","voice_category","text","date_unix","character_count_change_from","character_count_change_to","content_type","state","settings","feedback"],"title":"HistoryItemResponseModel"},"InvoiceResponseModel":{"properties":{"amount_due_cents":{"type":"integer","title":"Amount Due Cents"},"next_payment_attempt_unix":{"type":"integer","title":"Next Payment Attempt Unix"}},"type":"object","required":["amount_due_cents","next_payment_attempt_unix"],"title":"InvoiceResponseModel"},"LanguageResponseModel":{"properties":{"language_id":{"type":"string","title":"Language Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["language_id","name"],"title":"LanguageResponseModel"},"ManualVerificationFileResponseModel":{"properties":{"file_id":{"type":"string","title":"File Id"},"file_name":{"type":"string","title":"File Name"},"mime_type":{"type":"string","title":"Mime Type"},"size_bytes":{"type":"integer","title":"Size Bytes"},"upload_date_unix":{"type":"integer","title":"Upload Date Unix"}},"type":"object","required":["file_id","file_name","mime_type","size_bytes","upload_date_unix"],"title":"ManualVerificationFileResponseModel"},"ManualVerificationResponseModel":{"properties":{"extra_text":{"type":"string","title":"Extra Text"},"request_time_unix":{"type":"integer","title":"Request Time Unix"},"files":{"items":{"$ref":"#/components/schemas/ManualVerificationFileResponseModel"},"type":"array","title":"Files"}},"type":"object","required":["extra_text","request_time_unix","files"],"title":"ManualVerificationResponseModel"},"ModelResponseModel":{"properties":{"model_id":{"type":"string","title":"Model Id"},"name":{"type":"string","title":"Name"},"can_be_finetuned":{"type":"boolean","title":"Can Be Finetuned"},"can_do_text_to_speech":{"type":"boolean","title":"Can Do Text To Speech"},"can_do_voice_conversion":{"type":"boolean","title":"Can Do Voice Conversion"},"can_use_style":{"type":"boolean","title":"Can Use Style"},"can_use_speaker_boost":{"type":"boolean","title":"Can Use Speaker Boost"},"serves_pro_voices":{"type":"boolean","title":"Serves Pro Voices"},"token_cost_factor":{"type":"number","title":"Token Cost Factor"},"description":{"type":"string","title":"Description"},"requires_alpha_access":{"type":"boolean","title":"Requires Alpha Access"},"max_characters_request_free_user":{"type":"integer","title":"Max Characters Request Free User"},"max_characters_request_subscribed_user":{"type":"integer","title":"Max Characters Request Subscribed User"},"languages":{"items":{"$ref":"#/components/schemas/LanguageResponseModel"},"type":"array","title":"Languages"}},"type":"object","required":["model_id","name","can_be_finetuned","can_do_text_to_speech","can_do_voice_conversion","can_use_style","can_use_speaker_boost","serves_pro_voices","token_cost_factor","description","requires_alpha_access","max_characters_request_free_user","max_characters_request_subscribed_user","languages"],"title":"ModelResponseModel"},"ProjectExtendedResponseModel":{"properties":{"project_id":{"type":"string","title":"Project Id"},"name":{"type":"string","title":"Name"},"create_date_unix":{"type":"integer","title":"Create Date Unix"},"default_title_voice_id":{"type":"string","title":"Default Title Voice Id"},"default_paragraph_voice_id":{"type":"string","title":"Default Paragraph Voice Id"},"default_model_id":{"type":"string","title":"Default Model Id"},"last_conversion_date_unix":{"type":"integer","title":"Last Conversion Date Unix"},"can_be_downloaded":{"type":"boolean","title":"Can Be Downloaded"},"state":{"type":"string","enum":["default","converting","in_queue"],"title":"State"},"chapters":{"items":{"$ref":"#/components/schemas/ChapterResponseModel"},"type":"array","title":"Chapters"}},"type":"object","required":["project_id","name","create_date_unix","default_title_voice_id","default_paragraph_voice_id","default_model_id","last_conversion_date_unix","can_be_downloaded","state","chapters"],"title":"ProjectExtendedResponseModel"},"ProjectResponseModel":{"properties":{"project_id":{"type":"string","title":"Project Id"},"name":{"type":"string","title":"Name"},"create_date_unix":{"type":"integer","title":"Create Date Unix"},"default_title_voice_id":{"type":"string","title":"Default Title Voice Id"},"default_paragraph_voice_id":{"type":"string","title":"Default Paragraph Voice Id"},"default_model_id":{"type":"string","title":"Default Model Id"},"last_conversion_date_unix":{"type":"integer","title":"Last Conversion Date Unix"},"can_be_downloaded":{"type":"boolean","title":"Can Be Downloaded"},"title":{"type":"string","title":"Title"},"author":{"type":"string","title":"Author"},"isbn_number":{"type":"string","title":"Isbn Number"},"acx_volume_normalization":{"type":"boolean","title":"Acx Volume Normalization"},"state":{"type":"string","enum":["default","converting"],"title":"State"}},"type":"object","required":["project_id","name","create_date_unix","default_title_voice_id","default_paragraph_voice_id","default_model_id","last_conversion_date_unix","can_be_downloaded","title","author","isbn_number","acx_volume_normalization","state"],"title":"ProjectResponseModel"},"ProjectSnapshotResponseModel":{"properties":{"project_snapshot_id":{"type":"string","title":"Project Snapshot Id"},"project_id":{"type":"string","title":"Project Id"},"created_at_unix":{"type":"integer","title":"Created At Unix"},"name":{"type":"string","title":"Name"}},"type":"object","required":["project_snapshot_id","project_id","created_at_unix","name"],"title":"ProjectSnapshotResponseModel"},"ProjectSnapshotsResponseModel":{"properties":{"snapshots":{"items":{"$ref":"#/components/schemas/ProjectSnapshotResponseModel"},"type":"array","title":"Snapshots"}},"type":"object","required":["snapshots"],"title":"ProjectSnapshotsResponseModel"},"PronunciationDictionaryVersionLocatorDBModel":{"properties":{"pronunciation_dictionary_id":{"type":"string","title":"Pronunciation Dictionary Id"},"version_id":{"type":"string","title":"Version Id"}},"type":"object","required":["pronunciation_dictionary_id","version_id"],"title":"PronunciationDictionaryVersionLocatorDBModel"},"RecordingResponseModel":{"properties":{"recording_id":{"type":"string","title":"Recording Id"},"mime_type":{"type":"string","title":"Mime Type"},"size_bytes":{"type":"integer","title":"Size Bytes"},"upload_date_unix":{"type":"integer","title":"Upload Date Unix"},"transcription":{"type":"string","title":"Transcription"}},"type":"object","required":["recording_id","mime_type","size_bytes","upload_date_unix","transcription"],"title":"RecordingResponseModel"},"SampleResponseModel":{"properties":{"sample_id":{"type":"string","title":"Sample Id"},"file_name":{"type":"string","title":"File Name"},"mime_type":{"type":"string","title":"Mime Type"},"size_bytes":{"type":"integer","title":"Size Bytes"},"hash":{"type":"string","title":"Hash"}},"type":"object","required":["sample_id","file_name","mime_type","size_bytes","hash"],"title":"SampleResponseModel"},"SubscriptionResponseModel":{"properties":{"tier":{"type":"string","title":"Tier"},"character_count":{"type":"integer","title":"Character Count"},"character_limit":{"type":"integer","title":"Character Limit"},"can_extend_character_limit":{"type":"boolean","title":"Can Extend Character Limit"},"allowed_to_extend_character_limit":{"type":"boolean","title":"Allowed To Extend Character Limit"},"next_character_count_reset_unix":{"type":"integer","title":"Next Character Count Reset Unix"},"voice_limit":{"type":"integer","title":"Voice Limit"},"max_voice_add_edits":{"type":"integer","title":"Max Voice Add Edits"},"voice_add_edit_counter":{"type":"integer","title":"Voice Add Edit Counter"},"professional_voice_limit":{"type":"integer","title":"Professional Voice Limit"},"can_extend_voice_limit":{"type":"boolean","title":"Can Extend Voice Limit"},"can_use_instant_voice_cloning":{"type":"boolean","title":"Can Use Instant Voice Cloning"},"can_use_professional_voice_cloning":{"type":"boolean","title":"Can Use Professional Voice Cloning"},"currency":{"type":"string","enum":["usd","eur"],"title":"Currency"},"status":{"type":"string","enum":["trialing","active","incomplete","incomplete_expired","past_due","canceled","unpaid","free"],"title":"Status"}},"type":"object","required":["tier","character_count","character_limit","can_extend_character_limit","allowed_to_extend_character_limit","next_character_count_reset_unix","voice_limit","max_voice_add_edits","voice_add_edit_counter","professional_voice_limit","can_extend_voice_limit","can_use_instant_voice_cloning","can_use_professional_voice_cloning","currency","status"],"title":"SubscriptionResponseModel"},"UserResponseModel":{"properties":{"subscription":{"$ref":"#/components/schemas/SubscriptionResponseModel"},"is_new_user":{"type":"boolean","title":"Is New User"},"xi_api_key":{"type":"string","title":"Xi Api Key"},"can_use_delayed_payment_methods":{"type":"boolean","title":"Can Use Delayed Payment Methods"}},"type":"object","required":["subscription","is_new_user","xi_api_key","can_use_delayed_payment_methods"],"title":"UserResponseModel"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerificationAttemptResponseModel":{"properties":{"text":{"type":"string","title":"Text"},"date_unix":{"type":"integer","title":"Date Unix"},"accepted":{"type":"boolean","title":"Accepted"},"similarity":{"type":"number","title":"Similarity"},"levenshtein_distance":{"type":"number","title":"Levenshtein Distance"},"recording":{"$ref":"#/components/schemas/RecordingResponseModel"}},"type":"object","required":["text","date_unix","accepted","similarity","levenshtein_distance","recording"],"title":"VerificationAttemptResponseModel"},"VoiceResponseModel":{"properties":{"voice_id":{"type":"string","title":"Voice Id"},"name":{"type":"string","title":"Name"},"samples":{"items":{"$ref":"#/components/schemas/SampleResponseModel"},"type":"array","title":"Samples"},"category":{"type":"string","title":"Category"},"fine_tuning":{"$ref":"#/components/schemas/FineTuningResponseModel"},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels"},"description":{"type":"string","title":"Description"},"preview_url":{"type":"string","title":"Preview Url"},"available_for_tiers":{"items":{"type":"string"},"type":"array","title":"Available For Tiers"},"settings":{"$ref":"#/components/schemas/VoiceSettingsResponseModel"},"sharing":{"$ref":"#/components/schemas/VoiceSharingResponseModel"},"high_quality_base_model_ids":{"items":{"type":"string"},"type":"array","title":"High Quality Base Model Ids"}},"type":"object","required":["voice_id","name","samples","category","fine_tuning","labels","description","preview_url","available_for_tiers","settings","sharing","high_quality_base_model_ids"],"title":"VoiceResponseModel"},"VoiceSettingsResponseModel":{"properties":{"stability":{"type":"number","title":"Stability"},"similarity_boost":{"type":"number","title":"Similarity Boost"},"style":{"type":"number","title":"Style","default":0.0},"use_speaker_boost":{"type":"boolean","title":"Use Speaker Boost","default":true}},"type":"object","required":["stability","similarity_boost"],"title":"VoiceSettingsResponseModel"},"VoiceSharingResponseModel":{"properties":{"status":{"type":"string","enum":["enabled","disabled","copied","copied_disabled"],"title":"Status"},"history_item_sample_id":{"type":"string","title":"History Item Sample Id"},"original_voice_id":{"type":"string","title":"Original Voice Id"},"public_owner_id":{"type":"string","title":"Public Owner Id"},"liked_by_count":{"type":"integer","title":"Liked By Count"},"cloned_by_count":{"type":"integer","title":"Cloned By Count"},"whitelisted_emails":{"items":{"type":"string"},"type":"array","title":"Whitelisted Emails"},"name":{"type":"string","title":"Name"},"labels":{"additionalProperties":{"type":"string"},"type":"object","title":"Labels"},"description":{"type":"string","title":"Description"},"review_status":{"type":"string","enum":["not_requested","pending","declined","allowed","allowed_with_changes"],"title":"Review Status"},"review_message":{"type":"string","title":"Review Message"},"enabled_in_library":{"type":"boolean","title":"Enabled In Library"}},"type":"object","required":["status","history_item_sample_id","original_voice_id","public_owner_id","liked_by_count","cloned_by_count","whitelisted_emails","name","labels","description","review_status","review_message","enabled_in_library"],"title":"VoiceSharingResponseModel"}}},"tags":[{"name":"text-to-speech","description":"Convert text into lifelike speech using a voice of your choice."},{"name":"speech-to-speech","description":"Create speech by combining the style and content of an audio file you upload with a voice of your choice."},{"name":"models","description":"Access the different models of the platform."},{"name":"voices","description":"Access to voices created either by you or us."},{"name":"samples","description":"Access to your samples. A sample is any audio file you attached to a voice. A voice can have one or more samples."},{"name":"history","description":"Accesses your history. Your history is a list of all your created audio including its metadata."},{"name":"projects","description":"Access, create and convert Projects programmatically, only specifically whitelisted accounts can access the Projects API. If you need access please contact our sales team."}]} \ No newline at end of file