---
title: "Generate sound effects"
method: POST
path: "/v1/sound_effect"
tags: ["Start generating"]
---

# Generate sound effects

`POST /v1/sound_effect`

This endpoint will start a new task to generate sound effects from a text description.

## Headers

- `X-Runway-Version` '2024-11-06', required

## Request body

- union
  - object
    - `promptText` string, required — A non-empty text prompt. For text-to-speech, the words to speak. For text-to-audio, a scene description that can include voice direction, dialogue, music, and sound effects.
    - `referenceAudios` union[] — Up to three reference audio clips. When provided, reference them in promptText as @Audio1, @Audio2, and @Audio3 in order.
      - union — A HTTPS URL, Runway or data URI containing an encoded audio. See [our docs](/assets/inputs#audio) on audio inputs for more information.
        - string — A HTTPS URL, Runway upload URI, or base64 data URI (e.g. `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See [our docs](/assets/inputs#audio) on audio inputs for more information.
        - string — A Runway upload URI. See https://docs.dev.runwayml.com/assets/uploads for more information.
        - string — A data URI containing encoded media.
    - `speechRate` integer — Relative speech speed. Negative is slower, positive is faster; 0 is normal.
    - `loudnessRate` integer — Relative output loudness. Negative is quieter, positive is louder; 0 is normal.
    - `pitchRate` integer — Pitch shift in semitones. Negative lowers, positive raises; 0 is unchanged.
    - `sampleRate` 8000 | 16000 | 24000 | 32000 | 44100 | 48000 — Output sample rate in Hz.
    - `outputFormat` 'wav' | 'mp3' | 'ogg_opus' — Output audio container/format.
    - `model` 'seed_audio', required
  - object
    - `promptText` string, required — A text description of the sound effect to generate.
    - `duration` number — The duration of the sound effect in seconds, between 0.5 and 30 seconds. If not provided, the duration will be determined automatically based on the text description.
    - `loop` boolean — Whether the output sound effect should be designed to loop seamlessly.
    - `model` 'eleven_text_to_sound_v2', required

## Response `200`

The task that was created.

- object
  - `id` string, uuid, required — The ID of the task that was created. Use this to retrieve the task later.
  - `estimatedCost` object, required — The maximum credits this task may charge. The final amount may be lower after the task completes.
    - `credits` number, required — Estimated cost of the generation in credits.

## Other responses

- `400` — The request was rejected. Inspect `error` or `issues` (when present) and retry with a corrected request.
- `429` — You have exceeded the rate limit for this endpoint.

---

[API](https://skmtc.net/runwayml/apis/runwayml-api.md) · [All operations](https://skmtc.net/runwayml/apis/runwayml-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/runwayml/runwayml-api/revisions/3f3a4647d82f/schema)