---
title: "Documentation changes and compatibility"
canonical_url: https://docs.zvid.io/docs/changes-and-compatibility/
source: docs/changes-and-compatibility.md
content_revision: 6338386a1dd87e4a
---

# Documentation changes and compatibility

The website, OpenAPI reference, Markdown exports and LLM index are generated together. The [documentation index](https://docs.zvid.io/docs-index.json) includes a content revision that identifies the documentation snapshot. It is not an API version or a guarantee that every deployment has identical capabilities.

## Documentation update prepared 22 September 2026

This update corrects the documented contract and adds readable reference content; it does not announce a new runtime release.

- API endpoint bodies include authentication, fields, constraints, examples and responses in the initial HTML.
- Authoring/validation and template management endpoints are included in the API reference.
- Template preview is documented as a free dry-run returning resolved project JSON and stats.
- Webhook examples use the event envelope, distinguish registered signed deliveries from unsigned per-request callbacks, and explain raw-body verification.
- Separate schemas describe authored projects, resolved projects and REST request envelopes.
- All guides have portable Markdown, with a complete index and a full-text export.
- Assistant setup, validation/cost checks, core concepts, task recipes and production error handling have dedicated guides.

## Hosted API and editor differences

The editor can represent options that a hosted render route does not accept. Exported JSON must be checked against the current API contract and your account limits. In particular, the hosted request frame-rate ceiling is 60 fps even where editor controls allow higher values. See [editor export](https://docs.zvid.io/docs/editor/export/).

Some transition names can appear in one renderer or validation layer without being available in all interfaces. Use the supported intersection documented in [transition effects](https://docs.zvid.io/docs/structure/properties/xfade-effects/) and validate the exact project.

## Authoring is a separate validation stage

Template expressions and iteration belong to an authored project. The resolved-project schema describes the result after data resolution. A resolved-only schema can incorrectly reject a valid authored template, while an authoring schema cannot prove that every future variable set will resolve successfully. See [schema resources](https://docs.zvid.io/docs/documentation-resources/).

For account-specific restrictions and the current credit estimate, [validate the exact request](https://docs.zvid.io/docs/validate-and-estimate/). Limits, installed integration versions and deployed services can change independently of a cached documentation page.

## Updating an integration

Keep the installed SDK or automation package version with your release record. Re-run validation on representative requests when changing templates, media inputs, dimensions, output types or dependency versions. Check [integration availability](https://docs.zvid.io/docs/integrations/), preserve returned job identifiers, and review [retry behavior](https://docs.zvid.io/docs/operations/errors-and-retries/) before enabling automatic retries.

If a response disagrees with the reference, retain its status, timestamp and job ID when available, then contact us at [https://zvid.io/contact](https://zvid.io/contact) to send a redacted example. Do not guess an unsupported endpoint or silently discard the discrepancy.