Developers

Three ways to build on Dezignee.

One command-driven document engine powers the editor UI, the AI, and MCP. Embed it, stream from it, or drive it from your agent — your choice.

Get an API key MCP setup

Integration tracks

Pick the surface that fits your stack.

Mix and match — embed the editor for your users and drive the same workspace from an agent over MCP.

Track A · Plugin SDK

Embed the editor

Drop the full editor into your product. Your server mints a short-lived session from an API key; the iframe loads a sequence and edits it.

@dezignee/plugin

Track C · BYO chat

Bring your own chat

Already have a chat UI? Stream structured drafts into it over the REST AI endpoint with server-sent events.

POST /api/v1/ai/chat

MCP

Connect over MCP

Point Cursor, VS Code, or Claude Desktop at the Dezignee MCP servers to inspect workspaces and edit emails from your agent.

dezignee-plugin · dezignee-users

Track A

Embed the editor in minutes.

Install the plugin, create a session from your API key on the server, and mount the editor. The iframe authenticates with the short-lived session token — your API key never touches the browser.

Server creates a session: API key (dzg_api_) → session token (dzg_sess_).
The editor loads a sequence and applies commands as the user edits.
Export email-safe HTML from the host whenever you publish.

Embed with @dezignee/plugin

npm install @dezignee/plugin

POST /api/v1/emails/{id}/commands

{
  "commands": [
    {
      "type": "ELEMENT_UPDATE",
      "elementId": "btn_1",
      "props": { "backgroundColor": "#D97757" }
    }
  ]
}

One pipeline

Everything is a command.

Manual edits, AI chat, and MCP all emit the same typed commands against a versioned document. The backend validates each one and returns an RFC 6902 JSON patch plus a new version — so every client stays consistent and nothing is a one-way door.

Typed commands: ELEMENT_UPDATE, ROW_INSERT, META_UPDATE, and more.
Each call returns a JSON patch + incremented version.
The same endpoint backs a single email or a whole sequence.

MCP servers

Two servers for two jobs.

A read-only server for developer setup and inspection, and a read-write server for design assistance and command emission.

dezignee-pluginread-only

Setup & inspection for Cursor and VS Code — detect your stack, scaffold the embed, and inspect a workspace without changing anything.

detect_projectinstall_bridgecreate_embed_componentconfigure_initworkspace_overviewlist_sequenceslist_emailsdiagnostics

dezignee-usersread-write

Design assistance & command emission for Claude Desktop — suggest improvements and apply changes to a live email or sequence.

suggest_copysuggest_layoutsuggest_stylesgenerate_commandsapply_commandsapply_ai_suggestion

claude_desktop_config.json

{
  "mcpServers": {
    "dezignee-users": {
      "command": "python",
      "args": [
        "/path/to/dezignee-backend/scripts/mcp-users-server.py",
        "--workspace-id=your-workspace-id",
        "--api-key=dzg_api_your-api-key",
        "--api-url=https://api.dezignee.com"
      ]
    }
  }
}

email://{emailId}

An email document — current or a specific version.

sequence://{sequenceId}

A sequence with all of its emails.

workspace://{workspaceId}

Workspace metadata, sequences, and emails.

Track C · BYO chat

Stream drafts into your own UI.

The AI endpoint streams tokens over server-sent events, so you can render the draft as it forms inside your existing chat interface.

POST /api/v1/ai/chat

curl -N https://api.dezignee.com/api/v1/ai/chat \
  -H "Authorization: Bearer dzg_api_your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "sequenceId": "seq_123",
    "message": "Write a 3-step trial onboarding sequence"
  }'
# → text/event-stream

Auth & keys

Three tokens, clear roles.

dzg_api_…API key

Created per workspace with read / write scopes. Lives on your server; mints sessions and authorizes MCP.

dzg_sess_…Session token

Short-lived, scoped to one editor session. Safe to hand to the iframe.

JWTUser token

Google OAuth or magic link, for dashboard users managing workspaces and keys.

Get an API key and start building.

Create a workspace, generate a key, and embed the editor or connect your agent today.

Start free Talk to us