Developer docs
MarkdownThe basics
| Item | Value |
|---|---|
| Base URL | https://api.mirabase.dev |
| Authentication | Authorization: Bearer mb_live_... |
| OpenAPI | https://api.mirabase.dev/v2/openapi.yaml |
| Guide for Agents | https://api.mirabase.dev/llms.txt |
| SDK | TypeScript: npm install https://mirabase.io/sdk/mirabase-sdk-0.3.0-rc.1.tgz. Python: pip install https://mirabase.io/sdk/mirabase-0.3.0rc1-py3-none-any.whl |
| Markdown | Add .md to the address of any page for its Markdown version, made for Agents. Every page is listed in llms.txt, and all the guides are in one file at llms-full.txt. |
What is available
| Capability | Status |
|---|---|
| API keys, principals, Spaces, and members | Implemented |
| Files, tree, batches, and large uploads | Implemented |
| Entries, versions, reverts, processing, and erasure | Implemented |
| Change feed | Implemented |
| Usage, limits, and audit | Implemented |
| Copies, version diffs, lineage, and download URLs | Implemented |
| Read and write roots, proposals, and review | Implemented |
| Background subtree jobs and large merges | Implemented |
| Retrieval, context, and answers with citations | Implemented |
| Memory | Implemented |
| Offline consolidation (optional per deployment): dormancy and waking, memory proposals and approval, reports, undo, the MEMORY.md index, and RECENT.md | Implemented |
| Branches, checkpoints, and merges | Implemented |
| Snapshots, webhooks, export, and import | Implemented |
| Forking a Space, cancelling jobs, and listing copies | Coming soon |
| The CLI: mounts and Git workspaces | Coming soon |
Contents
- 5-minute quickstartWrite and read a file by path, edit it and see its versions, compare and revert; let an Agent change files on a branch and merge; get an answer that cites the file version; connect an Agent over MCP.
- Authentication and API keysSend, create, limit, rotate, and revoke API keys.
- SDKInstall and configure the TypeScript and Python clients, and learn what they handle for you: Space selection, streaming answers, errors, retries, and pagination.
- Core conceptsThe data model behind the API: Spaces, Entries and versions, files, knowledge, memory, branches, and access control.
- GlossaryThe terms these docs use, each defined in one sentence and linked to the page that explains it.
- Files and versionsWrite, read, edit, and organize files, compare and revert versions, and handle Agent proposals.
- Processing statusA file becomes searchable first, and memories are built afterwards: wait for a single file, track a bulk import, and check whether content is still being processed.
- Sync, snapshots, and exportMirror a Space with the tree, the change feed, and webhooks, pin a moment with snapshots, and move a whole Space with export and import.
- Retrieval and contextUse `search` when you choose the sources, `context` when the service chooses and budgets them, and `answer` when you want a cited answer.
- MemoryWrite, distill, review, correct, and forget memories, and consolidate them offline.
- Connect an Agent (MCP)Connect Agents such as Claude Code and Codex to Mirabase over MCP: how to connect, protocol versions, the tools and their parameters, and the recommended call order.
- Framework integrationsComing soonUse Mirabase's tools, memory, and retrieval from the Vercel AI SDK, LangChain, LlamaIndex, the OpenAI Agents SDK, Mastra, and CrewAI.
- Branches and mountsCopy-on-write workspaces for Agents, FUSE mounts, a sync command, and Git workspaces.
- PermissionsHow principals, capabilities, Space roles, read and write roots, and API key limits together decide a request.
- API conventionsThe rules every endpoint shares: requests and responses, request ids, versions, pagination, idempotency, conditional requests, jobs, errors, retries, and rate limits.
- Error codesEvery error code an API key can receive, with its HTTP status, remediation.action, meaning, and Retry-After.
- SkillsMirabase's official skills tell an Agent when to call which MCP tool, in what order, and what to ask the user first. Nine skills cover the API task by task, and two cover complete scenarios: project memory and a knowledge base with cited answers.
- Build on MirabaseWhat the SDKs, MCP, skills, skills stored in a Space, webhooks, and provider plugins are each for and how they combine; the core calls of an application; and how to write and check a skill of your own.
- Full API referenceEvery endpoint, parameter, and schema, generated from the OpenAPI document.
