# Zvid

> Zvid renders videos and still images from project JSON. The same project model supports the visual editor, reusable templates, and automation.

## Start here

- [Documentation resources](https://docs.zvid.io/docs/documentation-resources/): formats, schemas, and how to use these references.
- [Complete documentation index](https://docs.zvid.io/docs-index.md): every current page, with HTML and Markdown links.
- [Quick Start](https://docs.zvid.io/markdown/docs/quick-start.md): authenticate, validate, render, and retrieve the result.
- [ChatGPT and AI assistants](https://docs.zvid.io/markdown/docs/ai-assistants.md): connect MCP, choose a profile, review drafts, and approve spending.
- [Free validation and credit estimates](https://docs.zvid.io/markdown/docs/validate-and-estimate.md): validate the exact request before rendering.
- [Project JSON](https://docs.zvid.io/markdown/docs/structure.md): fields, element types, timing, and defaults.
- [API reference](https://docs.zvid.io/markdown/docs/endpoints/zvid-api.md): complete endpoint inventory.
- [Full documentation export](https://docs.zvid.io/llms-full.txt): all pages with canonical URLs and page boundaries.

## Programmatic use

- API origin: https://api.zvid.io. Endpoint paths include /api.
- Create keys at https://app.zvid.io/api-keys. Send x-api-key: YOUR_API_KEY from your server; individual endpoint references state other accepted authentication.
- Submit either a project under payload or a stored template ID with variables. Never send both payload and template.
- Rendering is asynchronous and spends credits. Read the current credits guide and validate before submitting; image renders cost one credit per image, including bulk.
- A successful render submission returns jobId. Poll GET /api/jobs/{id}; completed queue results use result.url (database-backed lookups may return the URL directly in result), and failed jobs use failedReason.
- Webhook events have their own envelope. Registered webhooks and per-request callback URLs have different signing behavior; read the webhook guide before implementing verification.
- Hosted MCP: https://mcp.zvid.io/mcp. Client setup, available tools, authentication, and approval requirements depend on the selected interface/profile. Reading documentation does not authorize account actions.

## Authoritative references

- [OpenAPI](https://docs.zvid.io/openapi.yaml): documented public REST operations, security, request and response schemas.
- [Project authoring schema](https://docs.zvid.io/schemas/render-payload.schema.json): project fields; account-specific and semantic checks may require live validation.
- [Resolved project schema](https://docs.zvid.io/schemas/resolved-project.schema.json): concrete projects after template resolution.
- [Render request schema](https://docs.zvid.io/schemas/render-request.schema.json): the request envelope, payload/template exclusivity, variables and overrides.
- [Credits and limits](https://docs.zvid.io/markdown/docs/credits-and-plans.md).
- [Templates](https://docs.zvid.io/markdown/docs/templates/template-basics.md).
- [Webhook events](https://docs.zvid.io/markdown/docs/automation/webhooks.md).

Content revision: 6338386a1dd87e4a. Generated from the same documentation sources as HTML and per-page Markdown.