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
  • Base URL
  • Authentication
  • Request format
  • IDs
REST API Reference

REST API overview

Base URL, authentication, and conventions for the VideoGen REST API.
Was this page helpful?
Previous

Workflows

Pre-built, multi-step pipelines for common video production tasks.

Next
Built with

Base URL

https://api.videogen.io

Authentication

All requests require a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

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

Request format

  • All request bodies are JSON (Content-Type: application/json).
  • All tool endpoints are asynchronous: POST /v1/tools/... returns 202 Accepted with a toolExecutionId.
  • Poll GET /v1/tools/executions/{toolExecutionId} until status is succeeded, failed, or cancelled, or subscribe to webhooks.

IDs

All IDs are prefixed strings (e.g. vg_exec_..., vg_file_...). Store them as-is and do not parse them.