VideoGen API

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.

Authentication

AuthorizationBearer

API key from app.videogen.io/developers. The full key is only shown once when you create it.

API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Request

This endpoint expects an object.

promptstringRequired

A text description of the sound effect to generate.

durationSecondsdouble or nullOptional1-30

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

promptInfluencedouble or nullOptional

numResultsintegerOptional1-100Defaults to 1

Number of output results to generate. Defaults to 1.

isOutputTemporarybooleanOptionalDefaults to false

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.

Response

Execution accepted; poll until complete.

toolExecutionIdstring

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

1	import { VideoGenClient } from "@videogen/sdk";
2
3	async function main() {
4	const client = new VideoGenClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.tools.generateSoundEffect({
8	prompt: "Create a short, high-quality thunderclap sound effect with a deep rumble and sharp crack",
9	});
10	}
11	main();