--- title: ElevenLabs Text-to-Sound url: https://runapi.ai/docs/api/elevenlabs/text-to-sound.md canonical: https://runapi.ai/docs/api/elevenlabs/text-to-sound locale: en --- # ElevenLabs Text-to-Sound ## Overview Use the text to sound endpoint with the required inputs. Use the returned Task ID to retrieve its state, or provide callback_url for the deliveries documented below. ### Quick start 1. Create an API key and set it as RUNAPI_API_KEY. 2. Send a POST request whose body matches the request schema. 3. Store the returned task ID, then poll until a terminal state or handle the callbacks documented below. ## Endpoint POST /api/v1/elevenlabs/text_to_sound Base URL: https://runapi.ai API version: v1 Authentication: Authorization: Bearer YOUR_API_TOKEN ## Supported models Open a model page for current pricing, rate limits, and commercial-usage details. - [sound-effect-v2](/models/elevenlabs/sound-effect-v2) ## Request schema Send only the documented fields. When supplied, callback_url receives the Task deliveries documented below. ### sound-effect-v2 ```json { "callback_url": { "type": "string" }, "duration_seconds": { "type": "number" }, "loop": { "type": "boolean" }, "output_format": { "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" ], "type": "string" }, "prompt_influence": { "type": "number" }, "text": { "required": true, "type": "string" } } ``` ## Create acceptance HTTP 202 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" }, "task_replayed": { "type": "boolean" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling processing HTTP 200 - GET /api/v1/elevenlabs/text_to_sound/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling completed HTTP 200 - GET /api/v1/elevenlabs/text_to_sound/:id ### Response schema ```json { "properties": { "audios": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "audios", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "audios": [ { "url": "https://file.runapi.ai/reference-audio.mp3" } ], "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "completed" } ``` ## Polling failed HTTP 200 - GET /api/v1/elevenlabs/text_to_sound/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "type": "string" }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": "Task processing failed.", "id": "tsk_reference_demo", "status": "failed" } ``` ## Customer callback: completed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "audios": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "id": { "type": "string" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "audios" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "audios": [ { "url": "https://file.runapi.ai/reference-audio.mp3" } ], "id": "tsk_reference_demo", "status": "completed" } ``` ## Customer callback: failed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "error": { "oneOf": [ { "type": "string" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } ] }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "generation_failed", "message": "Task processing failed." }, "id": "tsk_reference_demo", "status": "failed" } ``` ## Errors HTTP 401 - POST /api/v1/elevenlabs/text_to_sound This response has no body. ## Errors HTTP 401 - GET /api/v1/elevenlabs/text_to_sound/:id This response has no body. ## Errors HTTP 400 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "text_is_required", "message": "text is required" } } ``` ## Errors HTTP 402 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "insufficient_balance", "message": "Insufficient balance" } } ``` ## Errors HTTP 403 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "api_token_credit_limit_exceeded", "message": "API key credit limit exceeded" } } ``` ## Errors HTTP 409 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "request_conflict", "message": "The request uses features that are not supported for the selected model" } } ``` ## Errors HTTP 429 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "rate_limited", "message": "Rate limit reached. Please retry later." } } ``` ## Errors HTTP 503 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "service_unavailable", "message": "Service under maintenance, please try again later" } } ``` ## Errors HTTP 504 - POST /api/v1/elevenlabs/text_to_sound ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": { "code": "timeout_error", "message": "The request timed out" } } ``` ## Errors HTTP 404 - GET /api/v1/elevenlabs/text_to_sound/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "not_found", "message": "Task with id 'tsk_reference_demo' not found" } } ``` ## Generated Code Samples Use cURL directly, or install an SDK for your language. Each sample submits the validated request shown in this reference. ### curl ```curl curl -X POST https://runapi.ai/api/v1/elevenlabs/text_to_sound \ -H 'Authorization: Bearer YOUR_API_TOKEN' \ -H 'Content-Type: application/json' \ -d '{"text":"Heavy rain on a tin roof.","loop":false,"duration_seconds":5,"prompt_influence":0.8,"output_format":"mp3_44100_128"}' ``` ### javascript #### Install ```bash npm install @runapi.ai/elevenlabs ``` ```javascript import { ElevenlabsClient } from "@runapi.ai/elevenlabs"; const client = new ElevenlabsClient({ apiKey: process.env.RUNAPI_API_KEY }); const task = await client.textToSound.create({ "text": "Heavy rain on a tin roof.", "loop": false, "duration_seconds": 5, "prompt_influence": 0.8, "output_format": "mp3_44100_128" }); ``` ### python #### Install ```bash pip install runapi-elevenlabs ``` ```python import os from runapi.elevenlabs import ElevenlabsClient client = ElevenlabsClient(api_key=os.environ["RUNAPI_API_KEY"]) task = client.text_to_sound.create( text="Heavy rain on a tin roof.", loop=False, duration_seconds=5, prompt_influence=0.8, output_format="mp3_44100_128" ) ``` ### go #### Install ```bash go get github.com/runapi-ai/elevenlabs-sdk/go@latest ``` ```go package main import ( "context" "log" "os" "github.com/runapi-ai/core-sdk/go/option" elevenlabs "github.com/runapi-ai/elevenlabs-sdk/go/elevenlabs" ) func main() { client, err := elevenlabs.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY"))) if err != nil { log.Fatal(err) } task, err := client.TextToSound.Create(context.Background(), elevenlabs.TextToSoundParams{ Text: "Heavy rain on a tin roof.", Loop: func(value bool) *bool { return &value }(false), DurationSeconds: func(value float64) *float64 { return &value }(5), PromptInfluence: func(value float64) *float64 { return &value }(0.8), OutputFormat: elevenlabs.SoundEffectOutputFormat("mp3_44100_128"), }) if err != nil { log.Fatal(err) } _ = task } ``` ### ruby #### Install ```bash gem install runapi-elevenlabs ``` ```ruby require "runapi/elevenlabs" client = RunApi::Elevenlabs::Client.new(api_key: ENV.fetch("RUNAPI_API_KEY")) task = client.text_to_sound.create( text: "Heavy rain on a tin roof.", loop: false, duration_seconds: 5, prompt_influence: 0.8, output_format: "mp3_44100_128" ) ``` ### java #### Install ```kotlin implementation("ai.runapi:runapi-elevenlabs") ``` ```java import ai.runapi.elevenlabs.ElevenLabsClient; import ai.runapi.elevenlabs.types.TextToSoundParams; import ai.runapi.core.polling.TaskCreateResponse; public final class Example { public static void main(String[] args) { ElevenLabsClient client = ElevenLabsClient.builder() .apiKey(System.getenv("RUNAPI_API_KEY")) .build(); TaskCreateResponse task = client.textToSound().create( TextToSoundParams.builder() .text("Heavy rain on a tin roof.") .loop(false) .durationSeconds(5) .promptInfluence(0.8) .outputFormat("mp3_44100_128") .build() ); } } ``` ### php #### Install ```bash composer require runapi-ai/elevenlabs ``` ```php textToSound->create([ "text" => "Heavy rain on a tin roof.", "loop" => false, "duration_seconds" => 5, "prompt_influence" => 0.8, "output_format" => "mp3_44100_128" ]); ``` ## Related Guides - [Authentication](/docs/guides/authentication) - [Quickstart](/docs/guides/task-api/quickstart)