Guides

Getting started

Get an API key, install an SDK, and learn the run-remix-export flow.

This guide walks you through everything you need to generate a finished video with the API. Set up your key and SDK below, then follow the three steps in order.

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.

Every request authenticates with a bearer token:

$Authorization: Bearer YOUR_API_KEY

See Authentication for key safety and per-language setup.

2. Install the SDK

$npm install @videogen/sdk

3. Verify your key

Before building, confirm your key works with a call to GET /v1/me. It takes no parameters and returns the account and team behind the key.

1import { VideoGenClient } from "@videogen/sdk";
2
3const client = new VideoGenClient({ token: process.env.VIDEOGEN_API_KEY });
4
5const me = await client.account.getMe();
6console.log(me.apiKeyId, me.apiKeyNickname, me.email, me.displayName, me.teamId);

A 200 response with your email and teamId means the key is valid. A 401 means the key is missing or wrong.

4. Follow the flow

Generating a video is a linear path of three steps. Work through them in order:

1

Run a workflow

Start a workflow from a script, voiceover, or slideshow. VideoGen builds the visuals, narration, and captions and creates a project.

Run a workflow

2

Apply remix actions

Optionally layer on edits: background music, a logo overlay, caption changes, or open-ended natural-language edits.

Apply remix actions

3

Export your video

Render the finished project to an MP4 and download it.

Export your video

What’s next