Sign in
Tools

Generate sound effect

Generate a sound effect from a text description. Optionally control the duration and prompt influence. VideoGen automatically routes each request to the most effective state-of-the-art sound effect model for your prompt and settings, so you don't pick a model.

post/v1/tools/generate-sound-effect

Request body

promptstring required

A text description of the sound effect to generate.

durationSecondsnumber nullable

Desired length of the sound effect in seconds, between 1 and 30. Defaults to about 10 seconds when omitted.

promptInfluencenumber nullable

How closely the generated sound effect follows the prompt, between 0 (more creative, more variation) and 1 (more literal, less variation). Defaults to a balanced value when omitted.

numResultsinteger

Number of output results to generate. Defaults to 1.

isOutputTemporaryboolean

When true, generated files are temporary. Temporary files are guaranteed to be available for 24 hours, after which they may be archived at any time. Temporary files are not analyzed (no description, transcript, or embedding will be generated), so they will not appear in search results. Defaults to false.

hideFromUiboolean

When true, generated files are hidden from the VideoGen Media page by default. They remain accessible through the API. Defaults to false.

Response

Execution accepted; poll until complete.

toolExecutionIdstring required

Execution id (e.g. vg_tool_...).

Changes

No recorded changes to this endpoint across all 1 revision of this API.