For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardAPI PricingGet an API key
  • Guides
    • Introduction
    • Getting started
    • Use with AI agents
    • Examples
    • Authentication
    • Handling async tasks
    • File uploads
    • File hydration
    • Embedding videos
    • Errors
    • Rate limits
    • Libraries & SDKs
  • REST API Reference
    • Overview
    • Workflows
        • POSTGenerate image
        • POSTGenerate video clip
        • POSTText to speech
        • POSTGenerate sound effect
        • POSTGenerate avatar clip
        • POSTVectorize image
        • POSTRemove background from an image
        • POSTRemove background from a video
        • POSTUpscale an image
        • POSTUpscale a video
        • POSTCancel tool execution
        • GETGet tool execution info
        • GETList files
        • POSTSearch files
        • GETGet file
        • POSTCreate file upload
        • POSTHydrate file
        • POSTArchive file
        • POSTEnable public preview
        • POSTDisable public preview
        • GETList avatar presenters
        • GETList TTS voices
        • GETList webhooks
        • POSTCreate webhook
        • DELDelete webhook
  • Webhook events
    • Overview
    • Changelog
LogoLogo
DashboardAPI PricingGet an API key
On this page
  • API keys
  • Creating a key
  • Keeping your key safe
  • Making requests
  • Error responses
Guides

Authentication

Every request to the VideoGen API must include your API key.
Was this page helpful?
Previous

Handling async tasks

Tool requests return immediately. You choose how to get the result.
Next
Built with

API keys

The VideoGen API uses Bearer token authentication. Include your API key in the Authorization header of every request:

$Authorization: Bearer YOUR_API_KEY

Creating a key

  1. Go to app.videogen.io/developers
  2. Click Create API key
  3. Copy the key immediately; it is only displayed once

Keeping your key safe

Your API key is a secret. Do not expose it in client-side code (browsers, mobile apps) or commit it to version control. Use environment variables or a secrets manager instead.

$export VIDEOGEN_API_KEY="vg_key_..."

Making requests

TypeScript
Python
cURL
1import { VideoGenClient } from "@videogen/sdk";
2
3const client = new VideoGenClient({
4 token: process.env.VIDEOGEN_API_KEY,
5});

Error responses

If your key is missing or invalid, the API returns 401 Unauthorized:

1{
2 "message": "Unauthorized"
3}