Grid82
grid82.comJoin the waitlist
DevelopersVersioning

Contract and resource versioning

Path-based API versioning (/v1), the x-grid82-api-version header, deprecation headers, and immutable page and workflow versions.

REST API versioning

All Grid82 REST routes live under /v1. Every response carries the exact contract version in the x-grid82-api-version header, matching info.version in the OpenAPI documents.

  • Additive changes stay under /v1. New endpoints, optional request parameters, and additional response keys ship without changing base paths. Ensure clients ignore unrecognized response keys.
  • No silent operation renames. Because operation IDs drive MCP tool names and CLI subcommands, renames go through formal deprecation (deprecated in OpenAPI, Deprecation and Link HTTP headers, and a Sunset header once scheduled for removal).
  • Breaking contract changes. Coordinated breaking changes across many routes will increment the path prefix to /v2.

Immutable Interface page versions

Every time a builder or user saves an Interface page (pages.codeSet / my.pages.codeSet), Grid82 compiles the TSX code and creates a new immutable version number. Publishing simply updates the live version pointer:

HTTP
GET  /v1/apps/{appId}/pages/{pageId}/versions
POST /v1/apps/{appId}/pages/{pageId}/publish   {"version": 4}

Users with a page already open finish their session on the version they loaded; rolling back points the app back to an earlier compiled version with zero rebuild delay.

Workflow version pins

Saving workflow source (workflows.codeSet) creates a new version, while live triggers remain on the currently activated version until you activate the new one. Runs already asleep on step.sleep or approval.ask finish on the version that started them.

Use these docs with your AI tools

An AI agent can read this documentation directly. You do not need an account or an API key. Everything here is public and read-only.

Query these docs via MCP

Recommended

Add this server to Claude, Claude Code, Cursor, Mistral, or any tool that supports MCP. Your agent can then search Grid82 documentation and read it in full, instead of answering from memory.

https://grid82.com/docs/mcp
  • searchFind the passages that answer a question.
  • fetchRead one page in full, as Markdown.
  • list_pagesSee every page in this documentation.

Query these docs over HTTP

The same tools also work as plain web requests. Use this for scripts, or for any tool that does not support MCP. There is one endpoint per tool. Arguments go in the query string, and the answer comes back as JSON.

https://grid82.com/docs/api/docs/search?query=custom+domain

Read the OpenAPI description. It is built from the same definitions as the tools, so it always matches what the endpoints do.

Read these docs as Markdown

Add .md to any page URL to get its Markdown source. You can also send the headerAccept: text/markdown to the page URL itself.

To read the whole documentation in one file, open llms-full.txt. For a short index of every page, open llms.txt.