# Zvid documentation index

Content revision: `6338386a1dd87e4a`. This identifier tracks source content, not a claim that every feature was reverified on a particular date.

- [Use Zvid with ChatGPT and AI assistants](https://docs.zvid.io/docs/ai-assistants/) — [Markdown](https://docs.zvid.io/markdown/docs/ai-assistants.md): Connect an AI assistant to Zvid, discover its tools, validate video and image projects, review credit estimates, and render approved media through MCP.
- [Authentication](https://docs.zvid.io/docs/authentication/) — [Markdown](https://docs.zvid.io/markdown/docs/authentication.md): Learn how to authenticate with Zvid API keys or account OAuth, create and protect credentials, and connect REST, MCP, n8n, and server workflows.
- [Bulk Rendering](https://docs.zvid.io/docs/automation/bulk-rendering/) — [Markdown](https://docs.zvid.io/markdown/docs/automation/bulk-rendering.md): Submit one Zvid template with many variable sets, validate bulk render requests, track every item, manage credits, and process results at scale.
- [Webhooks](https://docs.zvid.io/docs/automation/webhooks/) — [Markdown](https://docs.zvid.io/markdown/docs/automation/webhooks.md): Configure Zvid render webhooks, verify HMAC signatures, handle retries safely, test deliveries, and process completed or failed render events.
- [Documentation changes and compatibility](https://docs.zvid.io/docs/changes-and-compatibility/) — [Markdown](https://docs.zvid.io/markdown/docs/changes-and-compatibility.md): Understand Zvid documentation revisions, schema boundaries, hosted API versus editor compatibility, and the corrections introduced in this documentation update.
- [Projects, requests, templates and jobs](https://docs.zvid.io/docs/concepts/glossary/) — [Markdown](https://docs.zvid.io/markdown/docs/concepts/glossary.md): Understand Zvid projects, render request envelopes, elements, scenes, templates, variables, jobs and outputs before building a video or image integration.
- [Coordinates, sizing and layers](https://docs.zvid.io/docs/concepts/layout/) — [Markdown](https://docs.zvid.io/markdown/docs/concepts/layout.md): Place Zvid elements using canvas pixels, position presets, anchors, crop and resize settings, and understand layer ordering and text sizing interactions.
- [Media URLs, uploads and output files](https://docs.zvid.io/docs/concepts/media-assets/) — [Markdown](https://docs.zvid.io/markdown/docs/concepts/media-assets.md): Prepare accessible media URLs for Zvid, use uploaded files and stock assets, diagnose download failures, and preserve completed video and image outputs.
- [Timing, duration and scenes](https://docs.zvid.io/docs/concepts/timing/) — [Markdown](https://docs.zvid.io/markdown/docs/concepts/timing.md): Understand Zvid project time, scene-local time, source trimming, speed, automatic duration, transition overlap and explicit template timing requirements.
- [Credits, Plans & Limits](https://docs.zvid.io/docs/credits-and-plans/) — [Markdown](https://docs.zvid.io/markdown/docs/credits-and-plans.md): Understand how Zvid render credits are calculated, reserved, refunded, and combined across subscriptions and add-on packs, with current plan limits.
- [Reset your password](https://docs.zvid.io/docs/dashboard/account-password/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/account-password.md): Request a password reset email, choose a new password, and recover access to your Zvid account when you cannot sign in to the dashboard.
- [Update your profile](https://docs.zvid.io/docs/dashboard/account-settings/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/account-settings.md): Edit your profile name in the Zvid Dashboard, understand the account details shown in Settings, and learn how to request an email address change.
- [Join and use the affiliate program](https://docs.zvid.io/docs/dashboard/affiliate/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/affiliate.md): Join Zvid's affiliate program, copy your referral link, track referral commissions, and save the PayPal email used for your affiliate payouts.
- [Delete or replace an API key](https://docs.zvid.io/docs/dashboard/api-keys-delete/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/api-keys-delete.md): Delete an unused or exposed Zvid API key from the dashboard, understand the impact on integrations, and replace credentials before removing a key.
- [Create an API key](https://docs.zvid.io/docs/dashboard/api-keys/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/api-keys.md): Create a Zvid API key with a unique name, copy its complete secret while it is shown once, and configure it securely for an application or automation.
- [Create and monitor bulk renders](https://docs.zvid.io/docs/dashboard/bulk-renders/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/bulk-renders.md): Render a saved template for many rows of data, import a CSV, correct rejected rows, and monitor individual video or image outputs.
- [Credits and billing overview](https://docs.zvid.io/docs/dashboard/credits-and-billing/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/credits-and-billing.md): Find your Zvid credit balance and usage, buy credits, choose a subscription task, and get help with plan changes, renewal, or payment issues.
- [Check credits and usage](https://docs.zvid.io/docs/dashboard/credits/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/credits.md): Check your Zvid credit balance, understand rendering costs and reservations, review recent transactions, and redeem a credit promo code in the dashboard.
- [Create and render your first video](https://docs.zvid.io/docs/dashboard/first-video/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/first-video.md): Create a simple video in the Zvid visual editor, save your project, render it in the cloud and download the completed output from the dashboard.
- [Create an account and sign in](https://docs.zvid.io/docs/dashboard/getting-started-account/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/getting-started-account.md): Create your Zvid account, verify your email address, complete the initial account setup, and sign in to the dashboard to start creating videos.
- [Configure MCP and download an n8n agent](https://docs.zvid.io/docs/dashboard/integrations-mcp-n8n/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/integrations-mcp-n8n.md): Configure Zvid AI tool profiles and per-render credit limits, download an n8n agent workflow, and authorize an MCP client from your dashboard settings.
- [Dashboard overview](https://docs.zvid.io/docs/dashboard/overview/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/overview.md): Find projects, renders, templates, credits, developer tools, and account controls in the Zvid Dashboard, and learn where to start your first video.
- [Manage projects and saved drafts](https://docs.zvid.io/docs/dashboard/projects-and-renders/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/projects-and-renders.md): Create, reopen, and rename saved Zvid projects, copy their project IDs, and understand what happens when you delete an editable draft from the dashboard.
- [Cancel a subscription or undo cancellation](https://docs.zvid.io/docs/dashboard/subscription-cancel/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/subscription-cancel.md): Schedule your Zvid subscription to end, understand when your account moves to Free, and resume renewal by undoing a pending cancellation.
- [Manage your subscription and buy credits](https://docs.zvid.io/docs/dashboard/subscription/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/subscription.md): Subscribe to a Zvid plan, review an upgrade, schedule a downgrade or billing-period change, and purchase one-time credits from the dashboard.
- [Templates and bulk rendering](https://docs.zvid.io/docs/dashboard/templates-and-bulk/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/templates-and-bulk.md): Choose a Zvid template workflow for one personalized video or image, preview variable values for free, or create a batch from multiple rows of data.
- [Create and manage templates](https://docs.zvid.io/docs/dashboard/templates/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/templates.md): Create, edit, duplicate, preview, render, and archive reusable Zvid video and image templates, with variable inputs and troubleshooting steps.
- [Troubleshoot failed or delayed renders](https://docs.zvid.io/docs/dashboard/troubleshooting-renders/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/troubleshooting-renders.md): Diagnose failed renders, waiting jobs, missing output and inaccessible assets in the Zvid Dashboard without accidentally submitting duplicate paid jobs.
- [View, download, and manage renders](https://docs.zvid.io/docs/dashboard/videos/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/videos.md): Find rendered Zvid videos and images, check job status, download completed outputs, and rename or delete renders through the dashboard library.
- [Test and manage webhook deliveries](https://docs.zvid.io/docs/dashboard/webhooks-deliveries/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/webhooks-deliveries.md): Send a test event to a Zvid webhook, inspect recent delivery attempts and errors, pause event notifications, and delete an endpoint from the dashboard.
- [Add a webhook](https://docs.zvid.io/docs/dashboard/webhooks/) — [Markdown](https://docs.zvid.io/markdown/docs/dashboard/webhooks.md): Register a webhook endpoint in the Zvid Dashboard, select render completion and failure events, and copy the signing secret for your receiver.
- [Documentation for AI assistants and tools](https://docs.zvid.io/docs/documentation-resources/) — [Markdown](https://docs.zvid.io/markdown/docs/documentation-resources.md): Find Zvid's complete documentation index, clean Markdown pages, OpenAPI specification, project schemas, and free validation tools for reliable integrations.
- [Add animations and transitions](https://docs.zvid.io/docs/editor/animations/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/animations.md): Learn how to add enter and exit animations, transition between video clips, adjust color filters, and preview motion in the Zvid editor.
- [Add audio, music, and sound effects](https://docs.zvid.io/docs/editor/audio/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/audio.md): Add music, narration, and sound effects in the Zvid editor. Trim audio, adjust volume and speed, and match background tracks to the video length.
- [Canvas settings and positioning](https://docs.zvid.io/docs/editor/canvas/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/canvas.md): Set dimensions, frame rate, and output format in the Zvid editor. Position elements, arrange layers, use canvas guides, and add animated backgrounds.
- [Render, download, and export](https://docs.zvid.io/docs/editor/export/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/export.md): Render videos and images in the Zvid editor, download finished media, export JSON or code, and resolve validation, credit, connection, or render errors.
- [Add and edit images and GIFs](https://docs.zvid.io/docs/editor/images/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/images.md): Add images and GIFs in the Zvid editor, replace image sources, choose frame fit, adjust cropping and rounded corners, and preview visual effects.
- [Add and manage media](https://docs.zvid.io/docs/editor/media/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/media.md): Add media by URL, upload your own files, and search stock content in the Zvid editor. Learn how to reuse assets and safely delete account uploads.
- [Visual editor overview](https://docs.zvid.io/docs/editor/overview/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/overview.md): Explore the Zvid editor canvas, timeline, tool panels, and compact-screen controls. Start a video or image project, then save, preview, or render it.
- [Preview your video](https://docs.zvid.io/docs/editor/preview/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/preview.md): Preview your Zvid video before rendering. Play, scrub, and step through frames, review scene transitions, and check resolved template content.
- [Save, open, and import projects](https://docs.zvid.io/docs/editor/projects/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/projects.md): Save and reopen Zvid editor drafts, rename or copy projects, import project JSON, load example compositions, and understand cloud draft deletion.
- [Manage scenes and scene transitions](https://docs.zvid.io/docs/editor/scenes/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/scenes.md): Create and organize scenes in the Zvid editor. Set scene duration and backgrounds, add transitions, and manage content across the whole movie.
- [Add shapes and edit SVG](https://docs.zvid.io/docs/editor/shapes/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/shapes.md): Find and add vector shapes in the Zvid editor. Search the library, edit SVG markup, adjust layout and timing, and resolve invalid markup errors.
- [Editor keyboard shortcuts](https://docs.zvid.io/docs/editor/shortcuts/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/shortcuts.md): Use Zvid editor shortcuts for playback, frame stepping, undo, duplication, text editing, and zoom. Learn how selection changes keyboard behavior.
- [Add and edit subtitles](https://docs.zvid.io/docs/editor/subtitles/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/subtitles.md): Add subtitles in the Zvid editor. Import caption files, edit text and word timings, split or merge captions, and choose subtitle styling and animation.
- [Variables and render templates](https://docs.zvid.io/docs/editor/templates/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/templates.md): Create reusable Zvid render templates with typed defaults and placeholders. Preview variable values, repeat scenes, add conditions, and save templates.
- [Build graphics in Design Studio](https://docs.zvid.io/docs/editor/text-and-design/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/text-and-design.md): Build layered titles and graphics in Zvid Design Studio. Add text, shapes, and images, animate layers, edit designs, and reuse saved compositions.
- [Add and style text](https://docs.zvid.io/docs/editor/text/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/text.md): Add headings and labels in the Zvid editor. Edit text on the canvas, choose fonts, adjust typography, and set text timing, variables, and animations.
- [Timeline and timing](https://docs.zvid.io/docs/editor/timeline/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/timeline.md): Control timing in the Zvid editor. Move, trim, and split clips, arrange tracks, adjust automatic or fixed duration, and fix content that is cut off.
- [Add and trim video clips](https://docs.zvid.io/docs/editor/video/) — [Markdown](https://docs.zvid.io/markdown/docs/editor/video.md): Add and edit footage in the Zvid editor. Trim source clips, change playback speed, adjust embedded audio, split clips, and set their timeline windows.
- [Create API key](https://docs.zvid.io/docs/endpoints/create-api-key/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/create-api-key.md): Generate a new API key for the authenticated user Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Create project](https://docs.zvid.io/docs/endpoints/create-project/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/create-project.md): Save a new editor draft project. Provide the project JSON under payload (project is accepted as an alias). The draft becomes editable at...
- [Create template](https://docs.zvid.io/docs/endpoints/create-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/create-template.md): Save a reusable project. Requires explicit positive scene durations for video templates. Defaults must resolve successfully; no video is rendered.
- [Upload a file](https://docs.zvid.io/docs/endpoints/create-upload/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/create-upload.md): Multipart upload using the file field. Caps: images 25 MiB, GIFs 50 MiB, audio 100 MiB, video 300 MiB. Account storage defaults to 2 GiB but can vary; read...
- [Create webhook](https://docs.zvid.io/docs/endpoints/create-webhook/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/create-webhook.md): Register an account endpoint. Registered deliveries are signed with HMAC-SHA256(secret, timestamp + "." + raw body). There are at most 5 total attempts (initial...
- [Delete project](https://docs.zvid.io/docs/endpoints/delete-project/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/delete-project.md): Permanently delete a draft project. Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Archive template](https://docs.zvid.io/docs/endpoints/delete-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/delete-template.md): Archive the owned template. Existing outputs remain separate resources. Review authentication, request fields, response formats, examples, and constraints for this...
- [Delete upload](https://docs.zvid.io/docs/endpoints/delete-upload/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/delete-upload.md): Delete upload Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Delete webhook](https://docs.zvid.io/docs/endpoints/delete-webhook/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/delete-webhook.md): Delete webhook Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Duplicate template](https://docs.zvid.io/docs/endpoints/duplicate-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/duplicate-template.md): Create an independent copy of an owned template with an automatically derived name. No request body is needed and no render is submitted.
- [Get API key statistics](https://docs.zvid.io/docs/endpoints/get-api-key-stats/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-api-key-stats.md): Retrieve usage statistics for a specific API key, based on audit logs, for a given timeframe Review authentication, request fields, response formats, examples, and...
- [Get bulk render status](https://docs.zvid.io/docs/endpoints/get-bulk-render/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-bulk-render.md): Batch status with per-item job states and results. Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Get credit balance](https://docs.zvid.io/docs/endpoints/get-credit-balance/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-credit-balance.md): Retrieve the authenticated user's current credit balance Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Get creative library content](https://docs.zvid.io/docs/endpoints/get-library-content/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-library-content.md): Returns a 302 redirect to the versioned CDN JSON. Free items are public. Premium items require authentication and a paid plan. Follow the redirect and adapt the...
- [Get creative library metadata](https://docs.zvid.io/docs/endpoints/get-library-item/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-library-item.md): Read metadata for an active library item. Fetch its content separately. Review authentication, request fields, response formats, examples, and constraints for this...
- [Get MCP preferences](https://docs.zvid.io/docs/endpoints/get-mcp-preferences/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-mcp-preferences.md): Read account defaults used by the hosted MCP service. Change defaults in the dashboard; this REST operation is read-only.
- [Get project](https://docs.zvid.io/docs/endpoints/get-project/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-project.md): Get a draft project by ID, including its full project JSON. Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [Get element reference](https://docs.zvid.io/docs/endpoints/get-render-element/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-render-element.md): Free element fields, constraints and examples for the account. Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [Get authoring example](https://docs.zvid.io/docs/endpoints/get-render-example/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-render-example.md): Free named starter payload or request. Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Get render job status](https://docs.zvid.io/docs/endpoints/get-render-job/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-render-job.md): Retrieve the status, progress, and result of a render job by ID. Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [Get live render schema](https://docs.zvid.io/docs/endpoints/get-render-schema/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-render-schema.md): Free, account-aware resolved-project or render-request schema with validation notes and authoring guidance. Template input additionally supports variables, iterate...
- [Get template](https://docs.zvid.io/docs/endpoints/get-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-template.md): Fetch a stored template, including its variables defaults. Templates are authored in the editor (Save → Save as template) or via the dashboard.
- [Get transaction history](https://docs.zvid.io/docs/endpoints/get-transactions/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-transactions.md): Retrieve paginated list of credit transactions Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Get usage statistics](https://docs.zvid.io/docs/endpoints/get-usage-stats/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-usage-stats.md): Retrieve credit usage statistics for a specified timeframe Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Get user profile](https://docs.zvid.io/docs/endpoints/get-user-profile/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-user-profile.md): Retrieve the authenticated user's profile information and credit balance Review authentication, request fields, response formats, examples, and constraints for this...
- [Get webhook](https://docs.zvid.io/docs/endpoints/get-webhook/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/get-webhook.md): Get webhook Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [List API keys](https://docs.zvid.io/docs/endpoints/list-api-keys/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-api-keys.md): Retrieve all active API keys for the authenticated user Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [List bulk renders](https://docs.zvid.io/docs/endpoints/list-bulk-renders/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-bulk-renders.md): List the account's bulk render batches with per-state job counts. Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [List creative library items](https://docs.zvid.io/docs/endpoints/list-library-items/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-library-items.md): Public curated assets. Supply limit for paginated search; offset requires limit. q filters the paginated request. Without pagination, the whole current list is...
- [List projects](https://docs.zvid.io/docs/endpoints/list-projects/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-projects.md): List the account's editor draft projects. The full project JSON is not included — fetch a project by ID for that. Review authentication, request fields, response...
- [List supported elements](https://docs.zvid.io/docs/endpoints/list-render-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-render-elements.md): Free element catalogue and layout guidance. Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [List authoring examples](https://docs.zvid.io/docs/endpoints/list-render-examples/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-render-examples.md): Free generic starter requests. Use the creative library for designed examples, then adapt and validate. Review authentication, request fields, response formats,...
- [List render jobs](https://docs.zvid.io/docs/endpoints/list-render-jobs/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-render-jobs.md): List the account's render jobs, newest first. Filter by output type with type. Review authentication, request fields, response formats, examples, and constraints for...
- [List templates](https://docs.zvid.io/docs/endpoints/list-templates/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-templates.md): List the account's templates with their declared variables (variablesSummary). The full project JSON is not included — fetch a template by ID for that.
- [List uploads](https://docs.zvid.io/docs/endpoints/list-uploads/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-uploads.md): Your hosted media library — files usable directly as element src URLs. Review authentication, request fields, response formats, examples, and constraints for this...
- [List webhook deliveries](https://docs.zvid.io/docs/endpoints/list-webhook-deliveries/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-webhook-deliveries.md): Delivery log with status, attempts, and response codes. Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [List webhooks](https://docs.zvid.io/docs/endpoints/list-webhooks/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/list-webhooks.md): List webhooks Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Plan a creative video](https://docs.zvid.io/docs/endpoints/plan-creative-video/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/plan-creative-video.md): Build a free, plan-aware art-direction plan before authoring project JSON. The response includes scene roles and timing, style/layout directions, creative-library...
- [Resolve and validate template](https://docs.zvid.io/docs/endpoints/preview-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/preview-template.md): Free dry-run: substitute variables and overrides, then validate with account limits. Returns the resolved project and resolution statistics. Does not enqueue a...
- [Repair project JSON](https://docs.zvid.io/docs/endpoints/repair-render-project/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/repair-render-project.md): Free conservative mechanical repairs. Inspect changes and remainingErrors, then run remote validation. No render or credit reservation.
- [Revoke API key](https://docs.zvid.io/docs/endpoints/revoke-api-key/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/revoke-api-key.md): Revoke (delete) an API key belonging to the authenticated user Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [Search stock media](https://docs.zvid.io/docs/endpoints/search-stock-media/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/search-stock-media.md): Search Zvid's stock library. Anonymous requests use Free-plan renditions. Optional API-key authentication applies the account's media limits. Use returned URLs and...
- [Submit bulk render](https://docs.zvid.io/docs/endpoints/submit-bulk-render/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/submit-bulk-render.md): Submit one template (or inline payload) plus many variable sets. Each item becomes an individual render job with its own credits and webhook events. Validation is...
- [Submit bulk image render](https://docs.zvid.io/docs/endpoints/submit-image-bulk-render/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/submit-image-bulk-render.md): Image alias of the bulk render endpoint: every item must resolve to an image project (inline payloads are forced to type: "image"; a referenced template must be an...
- [Submit image render job](https://docs.zvid.io/docs/endpoints/submit-image-render-job/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/submit-image-render-job.md): Render a still image (PNG, JPG, or WebP) from a Zvid payload. This endpoint forces type: "image" on inline payloads, which must satisfy image-mode constraints. A...
- [Submit render job](https://docs.zvid.io/docs/endpoints/submit-render-job/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/submit-render-job.md): Submit a video or image asynchronously. Run the free validation endpoint first. Exactly one of payload or template is required. Inline and stored projects resolve...
- [Send test delivery](https://docs.zvid.io/docs/endpoints/test-webhook/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/test-webhook.md): Send test delivery Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Update API key](https://docs.zvid.io/docs/endpoints/update-api-key/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/update-api-key.md): Rename an active API key belonging to the authenticated user Review authentication, request fields, response formats, examples, and constraints for this Zvid API...
- [Update project](https://docs.zvid.io/docs/endpoints/update-project/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/update-project.md): Rename a draft project and/or replace its project JSON. At least one of name or payload is required; each update increments version.
- [Update template](https://docs.zvid.io/docs/endpoints/update-template/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/update-template.md): Update any supplied fields. Read the existing template before changing it. payload and project are aliases; never supply both.
- [Update webhook](https://docs.zvid.io/docs/endpoints/update-webhook/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/update-webhook.md): Update webhook Review authentication, request fields, response formats, examples, and constraints for this Zvid API operation.
- [Validate render request](https://docs.zvid.io/docs/endpoints/validate-render-job/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/validate-render-job.md): Free preflight through the same resolution and plan-aware validation pipeline as render submission. Returns the resolved payload, estimated credits and layout...
- [Zvid API](https://docs.zvid.io/docs/endpoints/zvid-api/) — [Markdown](https://docs.zvid.io/markdown/docs/endpoints/zvid-api.md): Use the Zvid REST API to validate projects, render videos and images, manage templates, and receive results through polling or registered webhooks.
- [Inspirational Video](https://docs.zvid.io/docs/examples/inspirational-video/) — [Markdown](https://docs.zvid.io/markdown/docs/examples/inspirational-video.md): Explore a complete 28-second Zvid motivational video with six clips on one timeline, two audio items, legacy karaoke subtitles, and its recorded JSON.
- [Pizza Margherita Reel](https://docs.zvid.io/docs/examples/pizza-margherita-reel/) — [Markdown](https://docs.zvid.io/markdown/docs/examples/pizza-margherita-reel.md): Explore a 25-second portrait recipe reel with eight image shots, one narration track, karaoke subtitles, and the complete JSON paired with its preview.
- [Zvid Ad](https://docs.zvid.io/docs/examples/zvid-ad/) — [Markdown](https://docs.zvid.io/markdown/docs/examples/zvid-ad.md): Build a 14-second Zvid promotional ad from HTML text, animated design elements, audio, and a complete JSON payload you can inspect and reuse.
- [Frequently Asked Questions](https://docs.zvid.io/docs/faq/) — [Markdown](https://docs.zvid.io/markdown/docs/faq.md): Find concise answers to common Zvid questions about rendering, the editor, API keys, credits, templates, media, webhooks, limits, and support.
- [Choose an SDK or automation integration](https://docs.zvid.io/docs/integrations/) — [Markdown](https://docs.zvid.io/markdown/docs/integrations.md): Choose direct REST, the published JavaScript SDK, hosted MCP, n8n or Make for Zvid, and distinguish released packages from source-only integration previews.
- [What is Zvid?](https://docs.zvid.io/docs/intro/) — [Markdown](https://docs.zvid.io/markdown/docs/intro.md): Learn what Zvid is, how JSON projects move through validation and cloud rendering, and when to use the API, visual editor, templates, or integrations.
- [Handle errors, timeouts and retries](https://docs.zvid.io/docs/operations/errors-and-retries/) — [Markdown](https://docs.zvid.io/markdown/docs/operations/errors-and-retries.md): Diagnose Zvid validation, authentication, credit, rate-limit and render errors, use bounded retries, and avoid duplicate paid jobs after uncertain submissions.
- [Submit, track and retrieve a render](https://docs.zvid.io/docs/operations/render-lifecycle/) — [Markdown](https://docs.zvid.io/markdown/docs/operations/render-lifecycle.md): Follow a Zvid render from free validation through submission, job polling, completion or failure, and safely retrieve and retain the output media URL.
- [Quick Start](https://docs.zvid.io/docs/quick-start/) — [Markdown](https://docs.zvid.io/markdown/docs/quick-start.md): Create an API key, validate and estimate a Zvid video request for free, submit a render, poll its job to completion, and retrieve the output URL.
- [Build a complete video or image workflow](https://docs.zvid.io/docs/recipes/) — [Markdown](https://docs.zvid.io/markdown/docs/recipes.md): Follow practical Zvid recipes for captioned clips, branded images, product videos, slideshows, narration and bulk personalization using maintained examples.
- [Rendering Images](https://docs.zvid.io/docs/rendering-images/) — [Markdown](https://docs.zvid.io/markdown/docs/rendering-images.md): Render PNG, JPG, or WebP images from Zvid JSON, configure dimensions and transparency, understand image credits, and submit single or bulk jobs.
- [JSON Structure Overview](https://docs.zvid.io/docs/structure/) — [Markdown](https://docs.zvid.io/markdown/docs/structure.md): Understand Zvid project JSON and its request envelope, including canvas settings, visual elements, scenes, audio, subtitles, variables, and output fields.
- [Animation Effects](https://docs.zvid.io/docs/structure/animations/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/animations.md): Configure enter and exit animations for Zvid visual elements using timing windows and supported xfade effects, with example fragments and a recorded preview.
- [Audio Elements](https://docs.zvid.io/docs/structure/audio-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/audio-elements.md): Add music, narration, and sound effects to a Zvid project with source trims, timeline bounds, speed, volume, and matchDuration looping behavior.
- [Common Element Properties](https://docs.zvid.io/docs/structure/common-properties/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/common-properties.md): Reference the timing, position, size, rotation, opacity, animations, crop, filters, and other properties shared by Zvid visual elements.
- [GIF Elements](https://docs.zvid.io/docs/structure/gif-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/gif-elements.md): Add animated GIF elements to Zvid projects with timing, position, resize, crop, filters, chroma key, zoom, and enter or exit animations.
- [Image Elements](https://docs.zvid.io/docs/structure/image-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/image-elements.md): Add remote raster images to Zvid projects and control timing, placement, resize, crop, filters, chroma key, rounded corners, zoom, and animations.
- [Anchor](https://docs.zvid.io/docs/structure/properties/anchor/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/anchor.md): Choose which point of a Zvid element aligns with its x and y coordinates, understand default anchors, and combine anchors with position presets.
- [BorderRadius](https://docs.zvid.io/docs/structure/properties/border-radius/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/border-radius.md): Round image, video, and GIF corners with a numeric pixel radius, and distinguish this media property from HTML CSS and subtitle background radius fields.
- [Caption](https://docs.zvid.io/docs/structure/properties/caption/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/caption.md): Define one timed subtitle caption in Zvid with text or word entries, start and end times, validation rules, and examples for precise caption playback.
- [ChromaKey](https://docs.zvid.io/docs/structure/properties/chroma-key/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/chroma-key.md): Remove a target color from Zvid video, GIF, or image elements using chroma key color, similarity, and blend settings, with explicit ranges and examples.
- [CropParams](https://docs.zvid.io/docs/structure/properties/crop-params/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/crop-params.md): Select a rectangular source region before Zvid composes an image, video, or GIF, using crop coordinates, dimensions, validation rules, and examples.
- [FilterOptions](https://docs.zvid.io/docs/structure/properties/filter-options/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/filter-options.md): Adjust media brightness, contrast, saturation, hue, blur, inversion, and tint with Zvid filter fields, numeric ranges, defaults, and example fragments.
- [PositionPreset](https://docs.zvid.io/docs/structure/properties/position/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/position.md): Place Zvid elements with canvas position presets, understand automatic x and y calculations, align anchors, or switch to explicit custom coordinates.
- [Resize](https://docs.zvid.io/docs/structure/properties/resize/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/resize.md): Scale Zvid image, video, and GIF elements with contain or cover behavior, preserve aspect ratio, understand cropping, and compare rendered examples.
- [ResolutionPreset](https://docs.zvid.io/docs/structure/properties/resolution-presets/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/resolution-presets.md): Choose a Zvid resolution preset for standard landscape, portrait, square, and social sizes, or use custom canvas width and height dimensions.
- [SubtitleStyles (legacy)](https://docs.zvid.io/docs/structure/properties/subtitle-styles/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/subtitle-styles.md): Reference the legacy Zvid SubtitleStyles block, its accepted caption styling fields, compatibility behavior, and migration to current flat subtitle options.
- [Word](https://docs.zvid.io/docs/structure/properties/word/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/word.md): Define each word's text, start time, and end time within Zvid subtitle captions, with timing validation and examples for word-level animation.
- [XFadeEffect](https://docs.zvid.io/docs/structure/properties/xfade-effects/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/xfade-effects.md): Choose FFmpeg xfade effect names for Zvid enter animations, exit animations, and video transitions, with a visual gallery of supported effects.
- [Zoom](https://docs.zvid.io/docs/structure/properties/zoom/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/properties/zoom.md): Apply a center-based Ken Burns zoom to Zvid image, video, and GIF elements, set zoom depth, combine it with crop or resize, and view an example.
- [Scenes](https://docs.zvid.io/docs/structure/scenes/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/scenes.md): Split a Zvid project into sequential scenes with local timelines, transitions, global overlays, and audio, then understand duration and ordering rules.
- [Subtitle](https://docs.zvid.io/docs/structure/subtitle/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/subtitle.md): Burn word-timed captions into Zvid videos, import SRT or VTT files, configure fonts and animation modes, and style active words and backgrounds.
- [SVG Elements (Deprecated)](https://docs.zvid.io/docs/structure/svg-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/svg-elements.md): Understand legacy SVG element support in Zvid, its security and validation limits, and how to migrate SVG graphics to supported HTML text elements.
- [Text & HTML Elements](https://docs.zvid.io/docs/structure/text-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/text-elements.md): Render plain text or HTML as Zvid visual layers, with typography, CSS, JavaScript, timing, positioning, animations, and secure custom code examples.
- [Video Transitions](https://docs.zvid.io/docs/structure/transitions/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/transitions.md): Blend adjacent Zvid video elements with FFmpeg xfade transitions, configure effect and duration, avoid overlap errors, and compare scene transitions.
- [Video Elements](https://docs.zvid.io/docs/structure/video-elements/) — [Markdown](https://docs.zvid.io/markdown/docs/structure/video-elements.md): Add remote video clips to Zvid timelines with trimming, speed, volume, resize, crop, filters, chroma key, zoom, animations, and transitions.
- [Dynamic Content](https://docs.zvid.io/docs/templates/dynamic-content/) — [Markdown](https://docs.zvid.io/markdown/docs/templates/dynamic-content.md): Use array iteration and boolean conditions in Zvid templates to generate scenes, show or hide content, and prepare personalized video or image requests.
- [Template Basics](https://docs.zvid.io/docs/templates/template-basics/) — [Markdown](https://docs.zvid.io/markdown/docs/templates/template-basics.md): Create reusable Zvid templates with declared variables, placeholders, defaults, validation, editor workflows, previews, and API rendering requests.
- [Validate a request and estimate credits](https://docs.zvid.io/docs/validate-and-estimate/) — [Markdown](https://docs.zvid.io/markdown/docs/validate-and-estimate.md): Check a Zvid render request, resolve template data, inspect warnings and estimate credits for free before submitting the same request to the render API.