REST API Reference

REST API overview

Base URL, authentication, and conventions for the VideoGen REST API.

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).
  • Workflow endpoints are asynchronous: POST /v1/workflows/... returns 202 Accepted with { workflowRunId, projectId, projectUrl }. Poll GET /v1/workflows/runs/{workflowRunId} until status is terminal. See Workflows.
  • Tool endpoints are asynchronous too: POST /v1/tools/... returns 202 Accepted with a toolExecutionId. Poll GET /v1/tools/executions/{toolExecutionId} until status is succeeded, failed, or cancelled.
  • Text generation is synchronous: POST /v1/text/generate returns 200 OK with the generated text inline — no polling.
  • Either async surface can notify you via webhooks instead of polling.

IDs

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