REST · OpenAPI 3.1 · Socket.IO realtime

Backend done before the coffee cools.

MUDBASE is one REST API with a published OpenAPI spec, SDKs, authentication, Socket.IO realtime, and signed webhooks. These docs are built so your first successful request happens on this page.

Get Started API Reference

First call in 60 seconds

sandbox project · no signup

01 · install

SHELL

npm install mudbase-sdk
# or: pnpm add mudbase-sdk
npm install mudbase-sdk
# or: pnpm add mudbase-sdk

02 · create a document

JavaScriptorders

const { data: result } = await data.createData(
  "proj_LZWZ9vzECKjB",
  "w7rksMuyUrwaPgkl",
  {
    email: "angela1@northwind.dev",
    firstName: "Patti",
    lastName: "Huel",
    role: "circuit index",
    status: "transmitter bypass"
  }
);
const { data: result } = await data.createData(
  "proj_LZWZ9vzECKjB",
  "w7rksMuyUrwaPgkl",
  {
    email: "angela1@northwind.dev",
    firstName: "Patti",
    lastName: "Huel",
    role: "circuit index",
    status: "transmitter bypass"
  }
);

03 · run it

201 Created

{
  "id": "doc_01J8ZQ4T7M2V",
  "collection": "orders",
  "data": {
    "item": "espresso"
  },
  "created_at": "2026-07-25T09:14:02.118Z",
  "version": 1
}
{
  "id": "doc_01J8ZQ4T7M2V",
  "collection": "orders",
  "data": {
    "item": "espresso"
  },
  "created_at": "2026-07-25T09:14:02.118Z",
  "version": 1
}

insert{ item: "espresso" }

Set up with AI

Cursor, Claude Code, any agent

Copy this into your coding agent to scaffold the SDK, env vars, and client init — it points the agent at the real spec instead of letting it guess. For deeper integration work, hand it the Mudbase Claude Skill — a complete, fact-checked reference for auth, collections, storage, realtime, MCP, add-ons, KYC, payment links, and wallet broadcasting.

Promptsetup-prompt.md

Set up Mudbase (backend-as-a-service) in this project.

1. Install the SDK:
   - Node/JS: npm install mudbase-sdk
   - Python: pip install mudbase-sdk

2. Create a .env with:
   MUDBASE_API_KEY=<from Console -> Settings -> API Keys>

3. Initialize the client (Node/JS example — each SDK has one class per API
   resource, e.g. AuthenticationApi, DataApi, no unified wrapper):
   import { Configuration, HealthApi } from 'mudbase-sdk';
   const configuration = new Configuration({
     basePath: 'https://cloud.mudbase.dev',
     apiKey: process.env.MUDBASE_API_KEY,
   });
   const health = new HealthApi(configuration);

4. Verify it works: await health.getHealth() should return a healthy status.

5. Before writing integration code, clone the Mudbase Claude Skill for the full,
   fact-checked reference (auth flows, collections, storage, realtime, webhooks,
   MCP, add-ons, KYC, payments, wallets):
     git clone https://github.com/themudhaxk/mudbase-skill.git ~/.claude/skills/mudbase
   Not using Claude Code? Read the same file directly:
   https://raw.githubusercontent.com/themudhaxk/mudbase-skill/main/SKILL.md

6. Or read https://docs.mudbase.dev/llms.txt for the full page index, or
   https://docs.mudbase.dev/openapi.yaml for the exact endpoint schemas — don't
   guess at request/response shapes.
Set up Mudbase (backend-as-a-service) in this project.

1. Install the SDK:
   - Node/JS: npm install mudbase-sdk
   - Python: pip install mudbase-sdk

2. Create a .env with:
   MUDBASE_API_KEY=<from Console -> Settings -> API Keys>

3. Initialize the client (Node/JS example — each SDK has one class per API
   resource, e.g. AuthenticationApi, DataApi, no unified wrapper):
   import { Configuration, HealthApi } from 'mudbase-sdk';
   const configuration = new Configuration({
     basePath: 'https://cloud.mudbase.dev',
     apiKey: process.env.MUDBASE_API_KEY,
   });
   const health = new HealthApi(configuration);

4. Verify it works: await health.getHealth() should return a healthy status.

5. Before writing integration code, clone the Mudbase Claude Skill for the full,
   fact-checked reference (auth flows, collections, storage, realtime, webhooks,
   MCP, add-ons, KYC, payments, wallets):
     git clone https://github.com/themudhaxk/mudbase-skill.git ~/.claude/skills/mudbase
   Not using Claude Code? Read the same file directly:
   https://raw.githubusercontent.com/themudhaxk/mudbase-skill/main/SKILL.md

6. Or read https://docs.mudbase.dev/llms.txt for the full page index, or
   https://docs.mudbase.dev/openapi.yaml for the exact endpoint schemas — don't
   guess at request/response shapes.