Getting started

Install an SDK and generate your first video clip in under a minute.

1. Get an API key

Go to app.videogen.io/developers and create an API key. The full key is only shown once, so copy and store it securely.

2. Install the SDK

TypeScript

Python

cURL

$ npm install @videogen/sdk

3. Generate a video clip

TypeScript

Python

cURL

1 import { VideoGenClient, pollExecutedTool } from "@videogen/sdk";
2 
3 const client = new VideoGenClient({ token: "YOUR_API_KEY" });
4 
5 const { toolExecutionId } = await client.tools.generateVideoClip({
6   prompt: "A sunset over a calm ocean, cinematic lighting",
7 });
8 
9 const result = await pollExecutedTool(client, toolExecutionId);
10 console.log(result);

The response includes a results array when the execution succeeds, where each entry contains a fileId, type, and an optional hydrated file with signed download URLs. You can also retrieve file metadata via GET /v1/files/{fileId}, or hydrate it via POST /v1/files/{fileId}/hydrate.

What’s next

Authentication: API key details and best practices
Handling async tasks: Learn how to retrieve results via polling or webhooks.
REST API Reference: Full endpoint documentation

1	import { VideoGenClient, pollExecutedTool } from "@videogen/sdk";
2
3	const client = new VideoGenClient({ token: "YOUR_API_KEY" });
4
5	const { toolExecutionId } = await client.tools.generateVideoClip({
6	prompt: "A sunset over a calm ocean, cinematic lighting",
7	});
8
9	const result = await pollExecutedTool(client, toolExecutionId);
10	console.log(result);