S
Supanote
Sign in Sign up
DEVELOPER PLATFORM · v1.0.0

REST API & Model Context Protocol (MCP)

Integrate Supanote into your terminal workflows, custom applications, and AI coding assistants like Cursor, Claude Desktop, Antigravity, and Windsurf.

Open Swagger UI Explorer → JSON OpenAPI 3.0 Spec MCP Quickstart ↓
Model Context Protocol (MCP) REST API v1 Encryption & Auth
AI ASSISTANT INTEGRATION

Model Context Protocol (MCP) Server

Supanote implements the open Model Context Protocol (Spec 2024-11-05) with zero external dependencies. This allows your LLMs (Claude, Cursor, Antigravity, etc.) to publish code snippets, inspect pastes, and perform deterministic syntax detection seamlessly.

HTTP & SSE Remote Transport

Cloud & Web Ready

Full JSON-RPC 2.0 API endpoint with Server-Sent Events (SSE) stream support for AI assistants, web clients, and cloud agents. No local files or Node.js environment required.

POST https://supanote.app/mcp
GET https://supanote.app/mcp/sse

Client Configuration Snippet

Get your Personal API Token in Settings →
Add this to your MCP configuration (e.g. Cursor, Claude Desktop, or Antigravity). Notes created via authenticated MCP will automatically link to your account: 
{
  "mcpServers": {
    "supanote": {
      "url": "https://supanote.app/mcp/sse?token=<YOUR_PERSONAL_API_TOKEN>"
    }
  }
}

Available MCP Tools

Tool Name Parameters Description
create_note content, title?, contentType?, visibility?, expiration?, password?, passwordHint? Creates a new note with deterministic detection and optional AES-256 password encryption.
get_note publicId, manageToken?, password? Retrieves note metadata and content. Supports password decryption for locked notes.
update_note publicId, manageToken, content?, title?, contentType?, expiration? Updates an existing paste using its secret management token.
delete_note publicId, manageToken Soft deletes note and revokes public link access.
detect_format content Runs zero-cost deterministic syntax detection (json, code, markdown, html, svg, log).
HTTP JSON API

REST API v1

Standard RESTful endpoints with clean JSON envelopes, strict content sniffing protection, and full CRUD support.

Launch Swagger UI →

Quickstart Examples (cURL)

1. Create a Paste: 
curl -X POST https://supanote.app/api/v1/notes \
  -H "Content-Type: application/json" \
  -d '{
    "content": "const express = require(\"express\");",
    "title": "Server Snippet",
    "contentType": "code"
  }'
2. Create an AES-256 Encrypted Note: 
curl -X POST https://supanote.app/api/v1/notes \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Confidential database password: secret-password-123",
    "title": "Vault Secret",
    "password": "mySecurePassword123!",
    "passwordHint": "Server root key"
  }'
3. Fetch & Decrypt an Encrypted Note: 
curl -X GET https://supanote.app/api/v1/notes/<note_id> \
  -H "X-Note-Password: mySecurePassword123!"
4. Update Note using Manage Token: 
curl -X PUT https://supanote.app/api/v1/notes/<note_id> \
  -H "X-Manage-Token: <manage_token>" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Updated Title" }'

Security & Rate Limits

All endpoints enforce automated rate limiting, payload size quotas (512 KB anonymous / 2 MB member), and strict CSP. Secret manage tokens are hashed using HMAC-SHA256 and never stored in plaintext.

Ready to explore all endpoints interactively?

Test parameters, see response schemas, and execute real requests directly from your browser.

Open Swagger UI →
Notification