> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.videogen.io/guides/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.videogen.io/_mcp/server. # Guides > HTTP API with TypeScript and Python SDKs for generating image, video, and audio assets with VideoGen. ## Docs - [Introduction](https://docs.videogen.io/introduction.md): Overview of the VideoGen API: end-to-end video workflows, the run-edit-export flow, the async execution model, base URL, and conventions. - [Getting started](https://docs.videogen.io/getting-started.md): Set up the VideoGen API: create an API key, install the TypeScript or Python SDK, and follow the linear path to generate, edit, and export a video. - [Run a workflow](https://docs.videogen.io/run-a-workflow.md): Step one of the VideoGen flow: start a workflow with POST /v1/workflows/*, then poll the run until the video is ready. - [Apply video edits](https://docs.videogen.io/apply-video-edits.md): Step two of the VideoGen flow: apply video edits (background music, logo, captions, transitions) to a project. - [Export your video](https://docs.videogen.io/export-your-video.md): Step three of the VideoGen flow: export a project with POST /v1/projects/{projectId}/export, then poll or wait for project_export.* webhooks before downloading the MP4. - [Workflows](https://docs.videogen.io/workflows.md): Start script-to-video, voiceover-to-video, slideshow-to-video, prompt-to-video-clip, or video-to-video workflows via POST /v1/workflows/*. Poll GET /v1/workflows/runs/{workflowRunId} or subscribe to workflow_run.* webhooks. - [Video edits](https://docs.videogen.io/video-edits.md): Reference for VideoGen video edits: background music, logo overlay, caption visibility and style, section and asset transitions. Apply them in a workflow call or via POST /v1/projects/{projectId}/video-edits. - [AI styles](https://docs.videogen.io/ai-styles.md): Example descriptions to pass as aiStyle when starting a workflow with an AI_IMAGE visual style. Pass the description text directly, or write your own. - [Model 1](https://docs.videogen.io/guides/model-1.md): Submit a generation, poll its status, and download the MP4. - [Handling async tasks](https://docs.videogen.io/handling-async-tasks.md): How VideoGen async work: tool executions, workflow runs, and project exports return ids immediately, then you poll or use webhooks for the result. - [Polling](https://docs.videogen.io/handling-async-tasks/polling.md): Poll GET endpoints for async status, or use SDK poll helpers for tool executions, workflow runs, and project exports. - [Webhooks](https://docs.videogen.io/handling-async-tasks/webhooks.md): Register webhook endpoints to receive tool_execution.*, workflow_run.*, project_export.*, file.*, and assistant_message.* events instead of polling. Includes setup, signature verification, and example payloads. - [File uploads](https://docs.videogen.io/file-uploads.md): Create a presigned upload URL, PUT file bytes, and poll until processing completes. Use uploaded files as inputs for generate-image, generate-video-clip, and other transformation tools. - [File hydration](https://docs.videogen.io/file-hydration.md): How file hydration works in the VideoGen API: call POST /v1/files/{id}/hydrate to get fresh signed URLs for thumbnails, previews, and downloads, or use the getHydratedFile SDK helper. - [Embedding videos](https://docs.videogen.io/embedding-videos.md): How to embed VideoGen media: enable public preview, get a playback ID or permanent public URL, and use @videogen/player or @videogen/player-react to render a branded player. - [Use with AI agents](https://docs.videogen.io/use-with-ai-agents.md): How to use the VideoGen API with AI coding assistants, MCP clients, and agent frameworks. Bind the TypeScript or Python SDK, or connect the MCP server. - [Examples](https://docs.videogen.io/examples.md): Example apps demonstrating the VideoGen API with popular frameworks including Next.js, FastAPI, Vercel AI SDK, and OpenAI Agents SDK. - [Libraries & SDKs](https://docs.videogen.io/libraries.md): Official TypeScript and Python SDKs for the VideoGen API, with links to GitHub, package registries, and per-language documentation. - [TypeScript](https://docs.videogen.io/libraries/typescript.md): Install and configure the @videogen/sdk TypeScript package. Covers client setup, video workflows, tool execution polling, file uploads/downloads, and webhook verification. - [Python](https://docs.videogen.io/libraries/python.md): Install and configure the videogen Python package. Covers sync and async clients, video workflows, tool execution polling, file uploads/downloads, and webhook verification. - [CLI](https://docs.videogen.io/libraries/cli.md): Install and use the VideoGen CLI. A single self-contained binary for calling the VideoGen API from your terminal, scripts, and CI. - [MCP server](https://docs.videogen.io/libraries/mcp.md): Connect the VideoGen MCP server (hosted remote or local) that exposes every VideoGen API capability as a tool for Cursor, Claude Desktop, Windsurf, and other MCP clients. - [n8n](https://docs.videogen.io/libraries/n8n.md): Use the n8n-nodes-videogen community node to start a VideoGen workflow and receive the finished MP4 in the same step. - [Pipedream](https://docs.videogen.io/libraries/pipedream.md): Use the VideoGen Pipedream components to start a VideoGen workflow and receive the finished MP4 in the same step. - [Postman](https://docs.videogen.io/libraries/postman.md): Import the VideoGen developer API into Postman to explore endpoints, authenticate with an API key, and run requests interactively. - [ChatGPT (custom GPT)](https://docs.videogen.io/libraries/chatgpt.md): Build a custom GPT in ChatGPT that calls the VideoGen API via GPT Actions, using the hosted OpenAPI document and an API key. Includes the AI plugin manifest for plugin hosts. - [Authentication](https://docs.videogen.io/authentication.md): Create an API key from the VideoGen dashboard, set the Authorization bearer header, and keep credentials safe with environment variables. - [OAuth 2.1 with VideoGen](https://docs.videogen.io/oauth.md): Use OAuth 2.1 (authorization code with PKCE) to let users authorize your application to call the VideoGen API on their behalf. Covers discovery, the authorization flow, scopes, and using the access token. - [Errors](https://docs.videogen.io/errors.md): Error response format, HTTP status codes, and common error codes returned by the VideoGen API. - [Pagination](https://docs.videogen.io/pagination.md): How cursor pagination works on VideoGen list endpoints: limit and cursor query params, hasMore and nextCursor response fields, and how to fetch every page. - [Rate limits](https://docs.videogen.io/rate-limits.md): Per-endpoint rate limits for the VideoGen API, including headers and best practices for handling 429 responses.