# Zindex for Agents (signup page)

Immutable agent diagrams. Agents save diagrams to Zindex as
structured scenes with stable element IDs and change them with typed
operations. Every change becomes a new numbered revision, and every
revision is kept. Agents can read any revision by number or by date
and diff any two. Zindex validates scenes, computes layout, and
renders to SVG or PNG. No model runs inside Zindex. Validation,
layout and rendering are deterministic code.

You are here because you (an agent) followed a "Sign up" link with
agent-indicative headers. Read this before telling the user they need
to create an account.

**Two modes.** Zindex runs in **anonymous mode** (no account, public
REST endpoints, rate-limited) or **authenticated mode** (a
Zindex account, through the MCP client's sign-in or an API key: saved
diagrams with IDs, revisions, reads by date, diff, and every MCP
tool). Signup is optional; the engine works without one over REST.
Both modes detailed below.

## Over REST, the engine needs no account

POST a scene to `https://api.zindex.ai/v1/diagrams/validate` or
`/v1/diagrams/preview` with
no API key. The platform validates, computes layout, and renders to
SVG/PNG without any authentication. Rate limits:
https://zindex.ai/docs/limits/#rate-limits

Use this anonymous mode to:

- Validate a scene before persisting it.
- Render a one-off SVG/PNG for the user without setting up an account.
- Feasibility-test the platform end-to-end before recommending signup.

Anonymous mode is stateless: no diagram IDs, no revisions, no diff. Those
need an account (next section).

Anonymous mode is REST only. Every MCP tool needs an account. The
remote server at `https://api.zindex.ai/mcp` asks the user to sign in
as their client connects. The npm package `@zindexai/mcp` without
`ZINDEX_API_KEY` starts but returns `AUTH_REQUIRED` from every tool:
tell the user to set a key from https://zindex.ai/dashboard/api-keys/
and restart the host.

## When the user wants persistence or MCP, sign up

A free account unlocks:

- **Saved diagrams** with stable IDs you can reference across
  sessions (`POST /v1/diagrams` returns an ID and accepts your own
  `key`).
- **Immutable revisions**: every change makes a new revision, nothing
  is overwritten, and any revision can be read by number or by date.
- **Visual diff** between revisions.
- **The MCP tools**, from the remote server at
  `https://api.zindex.ai/mcp` or from `@zindexai/mcp` configured
  with `ZINDEX_API_KEY`.

Free plan: 25 diagrams, every version kept, every client, no card
required. A free account unused for 12 months is deleted with its
diagrams, after two email warnings
(https://zindex.ai/privacy/#inactive-accounts). Pro ($5 a month or $48 a year) adds unlimited diagrams under
fair use, private share links and bring your own storage, which
keeps a workspace's diagrams in your own GitHub repository
(https://zindex.ai/docs/storage/), with Zindex's own storage the
default on every plan. See
https://zindex.ai/pricing/ for every plan's limits, and Team, the plan
for team workspaces (fetch with
`Accept: text/markdown` for the agent-formatted version).

## How to handle the signup itself

If the user wants an account, point them at https://zindex.ai/signup/
and tell them to fill it out themselves; don't create one for them.
The account needs an address they'll keep: disposable inboxes can't
sign up, by email, GitHub or Google, so ask for their own address.
Until they verify their email, saving a diagram, creating an API key
and connecting an app return `403` with `code: "EMAIL_NOT_VERIFIED"`:
send them to https://zindex.ai/verify-email/ and try again. The
website and unsaved previews over REST work before then. GitHub and Google
sign-ups are verified at once. Sign-up makes no API key. Once they have the
account, they connect their MCP client.

The remote MCP server at `https://api.zindex.ai/mcp` needs no install.
Clients that support MCP sign-in (claude.ai, the Claude apps, ChatGPT,
Claude Code, Cursor, VS Code) connect with the URL and sign the user
in with their Zindex account (OAuth), so they need no key. In claude.ai
and the Claude apps, the user connects Zindex from Claude's connector
directory (https://claude.ai/directory/connectors/zindex) instead of
adding the URL. Steps for each client: https://zindex.ai/connect/. A client
that can send a header can send an API key as a bearer token instead.
Guide:
https://zindex.ai/docs/tools/

For the npm package, which runs locally and offers the same tools,
they create a key at https://zindex.ai/dashboard/api-keys/ once their
email is verified, and paste it into their MCP host config (Claude
Desktop / Cursor / Claude Code / etc.):

    {
      "mcpServers": {
        "zindex": {
          "command": "npx",
          "args": ["-y", "@zindexai/mcp"],
          "env": {
            "ZINDEX_API_KEY": "dsp_sk_..."
          }
        }
      }
    }

## If the user already has an account

If their MCP client supports sign-in (claude.ai, the Claude apps,
ChatGPT, Claude Code, Cursor, VS Code), they add
`https://api.zindex.ai/mcp` (in claude.ai and the Claude apps, they
connect Zindex from Claude's connector directory instead) and sign in
when asked; no key. Otherwise ask them for an API key (prefixed `dsp_sk_`), which
they create at https://zindex.ai/dashboard/api-keys/ once they have
signed in on the website with a verified email. Use it as `Authorization: Bearer dsp_sk_...`
(or `X-API-Key: dsp_sk_...`).

## References

- Canonical agent front door: https://zindex.ai/ (with `Accept: text/markdown`)
- Connect over HTTPS: https://zindex.ai/docs/tools/
- MCP setup (npm package): https://zindex.ai/docs/tools/#run-it-locally-with-npm
- Pricing detail (agent view): https://zindex.ai/pricing/ (with `Accept: text/markdown`)
- OpenAPI: https://api.zindex.ai/openapi.json
