elevenlabs-n8n-node

{ "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. \u003Cbr/\u003E 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": ["speech-history"], "summary": "List Generated Items", "description": "Returns a list of your generated audio.", "operationId": "List_generated_items_v1_history_get", "parameters": [ { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "How many history items to return at maximum. Can not exceed 1000, defaults to 100.", "default": 100, "title": "Page Size" }, "description": "How many history items to return at maximum. Can not exceed 1000, defaults to 100." }, { "name": "start_after_history_item_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "After which 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.", "title": "Start After History Item Id" }, "description": "After which 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": "voice_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs.", "title": "Voice Id" }, "description": "Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs." }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "search term used for filtering", "examples": ["In the land far far away"], "title": "Search" }, "description": "search term used for filtering" }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": ["TTS", "STS"], "type": "string" }, { "type": "null" } ], "description": "Source of the generated history item", "examples": ["TTS"], "title": "Source" }, "description": "Source of the generated history item" }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpeechHistoryResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "history", "x-fern-sdk-method-name": "list" } }, "/v1/history/{history_item_id}": { "get": { "tags": ["speech-history"], "summary": "Get History Item", "description": "Retrieves a history item.", "operationId": "Get_history_item_v1_history__history_item_id__get", "parameters": [ { "name": "history_item_id", "in": "path", "required": true, "schema": { "type": "string", "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.", "examples": ["VW7YKqPnjY4h39yTbx2L"], "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." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeechHistoryItemResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "history", "x-fern-sdk-method-name": "get" }, "delete": { "tags": ["speech-history"], "summary": "Delete History Item", "description": "Delete a history item by its ID", "operationId": "Delete_history_item_v1_history__history_item_id__delete", "parameters": [ { "name": "history_item_id", "in": "path", "required": true, "schema": { "type": "string", "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.", "examples": ["VW7YKqPnjY4h39yTbx2L"], "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." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteHistoryItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "history", "x-fern-sdk-method-name": "delete" } }, "/v1/history/{history_item_id}/audio": { "get": { "tags": ["speech-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": [ { "name": "history_item_id", "in": "path", "required": true, "schema": { "type": "string", "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.", "examples": ["VW7YKqPnjY4h39yTbx2L"], "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." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "The audio file of the history item.", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "history", "x-fern-sdk-method-name": "get_audio" } }, "/v1/history/download": { "post": { "tags": ["speech-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": [ { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_Download_history_items_v1_history_download_post" } } } }, "responses": { "200": { "description": "The requested audio file, or a zip file containing multiple audio files when multiple history items are requested.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" }, "description": "ZIP file containing multiple audio files when multiple history items are requested" } } }, "400": { "description": "Invalid request", "content": { "application/json": { "example": { "error": "invalid_output_format", "message": "output_format must be wav or none" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "history", "x-fern-sdk-method-name": "download" } }, "/v1/sound-generation": { "post": { "tags": ["sound-generation"], "summary": "Sound Generation", "description": "Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects model in the world.", "operationId": "Sound_Generation_v1_sound_generation_post", "parameters": [ { "name": "output_format", "in": "query", "required": false, "schema": { "type": "string", "title": "Output format of the generated audio.", "description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.", "enum": [ "mp3_22050_32", "mp3_44100_32", "mp3_44100_64", "mp3_44100_96", "mp3_44100_128", "mp3_44100_192", "pcm_8000", "pcm_16000", "pcm_22050", "pcm_24000", "pcm_44100", "pcm_48000", "ulaw_8000", "alaw_8000", "opus_48000_32", "opus_48000_64", "opus_48000_96", "opus_48000_128", "opus_48000_192" ], "default": "mp3_44100_128" }, "description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_Sound_Generation_v1_sound_generation_post" } } } }, "responses": { "200": { "description": "The generated sound effect as an MP3 file", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "character-cost": { "description": "The number of characters used for billing", "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "text_to_sound_effects", "x-fern-sdk-method-name": "convert" } }, "/v1/audio-isolation": { "post": { "tags": ["audio-isolation"], "summary": "Audio Isolation", "description": "Removes background noise from audio", "operationId": "Audio_Isolation_v1_audio_isolation_post", "parameters": [ { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Audio_Isolation_v1_audio_isolation_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "audio/mpeg": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "audio_isolation", "x-fern-sdk-method-name": "convert" } }, "/v1/audio-isolation/stream": { "post": { "tags": ["audio-isolation"], "summary": "Audio Isolation Stream", "description": "Removes background noise from audio and streams the result", "operationId": "Audio_Isolation_Stream_v1_audio_isolation_stream_post", "parameters": [ { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Audio_Isolation_Stream_v1_audio_isolation_stream_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "audio/mpeg": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "audio_isolation", "x-fern-sdk-method-name": "stream", "x-fern-streaming": true } }, "/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": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.", "examples": ["21m00Tcm4TlvDq8ikWAM"], "title": "Voice Id" }, "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices." }, { "name": "sample_id", "in": "path", "required": true, "schema": { "type": "string", "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.", "examples": ["VW7YKqPnjY4h39yTbx2L"], "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." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSampleResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "samples", "x-fern-sdk-method-name": "delete" } }, "/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": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.", "examples": ["21m00Tcm4TlvDq8ikWAM"], "title": "Voice Id" }, "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices." }, { "name": "sample_id", "in": "path", "required": true, "schema": { "type": "string", "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.", "examples": ["VW7YKqPnjY4h39yTbx2L"], "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." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "responses": { "200": { "description": "Successful Response", "content": { "audio/*": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": ["voices", "samples", "audio"], "x-fern-sdk-method-name": "get" } }, "/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": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.", "examples": ["21m00Tcm4TlvDq8ikWAM"], "title": "Voice Id" }, "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices." }, { "name": "enable_logging", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Enable request logging.", "description": "When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers.", "default": true }, "description": "When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers." }, { "name": "optimize_streaming_latency", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "DEPRECATED. 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 None.\n", "deprecated": true }, "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 None.\n", "deprecated": true }, { "name": "output_format", "in": "query", "required": false, "schema": { "type": "string", "title": "Output format of the generated audio.", "description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.", "enum": [ "mp3_22050_32", "mp3_44100_32", "mp3_44100_64", "mp3_44100_96", "mp3_44100_128", "mp3_44100_192", "pcm_8000", "pcm_16000", "pcm_22050", "pcm_24000", "pcm_44100", "pcm_48000", "ulaw_8000", "alaw_8000", "opus_48000_32", "opus_48000_64", "opus_48000_96", "opus_48000_128", "opus_48000_192" ], "default": "mp3_44100_128" }, "description": "Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs." }, { "name": "xi-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "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.", "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." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_Text_to_speech_v1_text_to_speech__voice_id__post" } } } }, "responses": { "200": { "description": "The generated audio file", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-fern-sdk-group-name": "text_to_speech", "x-fern-sdk-method-name": "convert" } }, "/v1/text-to-speech/{voice_id}/with-timestamps": { "post": { "tags": ["text-to-speech"], "summary": "Text To Speech With Timestamps", "description": "Generate speech from text with precise character-level timing information for audio-text synchronization.", "operationId": "Text_to_speech_with_timestamps_v1_text_to_speech__voice_id__with_timestamps_post", "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.", "examples": ["21m00Tcm4TlvDq8ikWAM"], "title": "Voice Id" }, "description": "Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices." }, { "name": "enable_logging", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Enable request logging.", "description": "When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers.", "default": true }, "description": "When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers." }, { "name": "optimize_streaming_latency", "in": "query", "required": false, "schema": { "anyOf": [ { "ty