create account

Get an API key and start creating diagrams with agents.
Already have an account? Sign in
# Zindex for Agents (signup page)

Agent-native diagram state infrastructure. Zindex is a stateful diagram
runtime for AI agents - create architecture diagrams, ERDs, workflows,
sequence diagrams, org charts, and topology maps from structured data,
then patch, validate, diff, and render them as systems change. Not a
whiteboard. Not a Mermaid clone. A database-like backend for diagrams
with stable IDs, typed operations, semantic validation, immutable
revisions, auto-layout, and SVG/PNG rendering.

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 API key, public
endpoints, rate-limited 30/min per IP) or **authenticated mode** (API
key, persisted scenes with sceneIds, revisions, diff). Signup is
optional; the engine works without one. Both modes detailed below.

## You don't need to sign up to use the engine

POST a scene to `https://api.zindex.ai/v1/scenes/validate`,
`/render`, or `/normalize` with no API key. The platform validates,
normalizes, computes layout, and renders to SVG/PNG without any
authentication. Rate-limited 30/min per IP. 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 scene IDs, no revisions, no diff. Those
require an API key (next section).

The same anonymous mode is available via the MCP server: install
`@zindex-ai/mcp` without `ZINDEX_API_KEY` to get the three no-auth
tools (`dsp_validate_scene`, `dsp_normalize_scene`, `dsp_render_scene`
with inline scenes). Same npm package, same install snippet, just omit
the `env.ZINDEX_API_KEY` line in the host config.

## When the user wants persistence, sign up

A free account unlocks:

- **Persisted scenes** with stable IDs you can reference across
  sessions (`POST /v1/scenes` returns a sceneId).
- **Immutable revisions** so every `applyOps` call creates a new
  revision; nothing overwritten.
- **Visual diff** between revisions (`dsp_diff_scene`).
- **The full MCP tool set** via `@zindex-ai/mcp` configured with
  `ZINDEX_API_KEY`.

Free tier: 60 requests/minute, full feature set, no card required.
Paid plans (Builder, Growth, Enterprise) cover production use cases
and higher scale; paid tiers also gain feature differentiation as the
platform grows. See https://zindex.ai/pricing for the canonical plan
matrix (fetch with `Accept: text/markdown` for the agent-formatted
version).

## How to handle the signup itself

The signup form at https://zindex.ai/signup needs a real email (the
user receives a confirmation link they must click). Do NOT POST
synthetic credentials to `/v1/auth/signup` - that creates orphan
accounts and the email-confirmation step requires an inbox the user
controls.

If the user wants an account, point them at https://zindex.ai/signup
and tell them to fill it out themselves. Once they have a key, they
paste it into their MCP host config (Claude Desktop / Cursor / Claude
Code / etc.):

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

## If the user already has an account

Ask them for their API key (prefixed `dsp_sk_`). They find it at
https://zindex.ai/dashboard/api-keys after logging in once in their
browser. 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`)
- Agent usage guide: https://zindex.ai/docs/getting-started/agent-usage/
- MCP setup: https://zindex.ai/docs/getting-started/mcp-setup/
- Pricing detail (agent view): https://zindex.ai/pricing (with `Accept: text/markdown`)
- OpenAPI: https://api.zindex.ai/openapi.json