REST API overview
Base URL, authentication, and conventions for the VideoGen REST API.
Base URL
Authentication
All requests require a bearer token in the Authorization header:
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/...returns202 Acceptedwith{ workflowRunId, projectId, projectUrl }. PollGET /v1/workflows/runs/{workflowRunId}untilstatusis terminal. See Workflows. - Tool endpoints are asynchronous too:
POST /v1/tools/...returns202 Acceptedwith atoolExecutionId. PollGET /v1/tools/executions/{toolExecutionId}untilstatusissucceeded,failed, orcancelled. - Text generation is synchronous:
POST /v1/text/generatereturns200 OKwith the generatedtextinline — 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.