Overview#

This page lists every machine-readable resource we publish so that AI agents, LLM crawlers and automated tooling can consume the JSON2Video documentation and API surface without scraping HTML.

LLM-ready content#

We publish two plain-text bundles designed to be passed straight into an LLM context window.

• https://json2video.com/llms.txt — a short index following the llms.txt convention. Lives at the website root (not under /docs/v2/) because crawlers expect it there. Lists the main documentation entry points with one-line descriptions.
• https://json2video.com/llms-full.txt — the entire documentation site concatenated into a single markdown file, in navigation order, with the canonical URL preserved as a comment before each page. Generated by scripts/build-llms-full.sh in this repo and copied to the website root on each release.

.md per URL#

Every documentation page is also available as raw markdown by appending .md to its URL. No special headers, no auth. This makes it trivial to fetch a single page directly from an agent without parsing HTML.

Examples:

• https://json2video.com/docs/v2/getting-started/quickstart.md returns the raw quickstart markdown.
• https://json2video.com/docs/v2/reference/json-syntax/movie.md returns the raw Movie object reference.

The response is Content-Type: text/markdown; charset=utf-8. Missing pages return 404 Not Found with Content-Type: text/plain.

Schema downloads#

Static schemas you can point your validator at, or feed to an agent for structured output.

• OpenAPI spec — /docs/v2/openapi.yaml or /docs/v2/openapi.json — the v2 REST API description (endpoints, request/response shapes, auth). Covers /movies, /templates and /media.
• JSON Schema for Movie — /docs/v2/movie-schema.json — the schema for the Movie object passed to POST /v2/movies. Use it for client-side validation or to constrain model output (e.g. with structured outputs).

See also#

• MCP server — wire the @json2video/cli MCP into Claude Code, Cursor or Windsurf to give your agent direct access to render, status and validation tools.
• Rules for your agent — copy-paste rule blocks for CLAUDE.md, AGENTS.md and .cursorrules.