MuseCanto Developer Documentation
Integrate MuseCanto with scripts, automation, and third-party tools using user API keys.
Welcome to the MuseCanto developer documentation. Use user API keys to read and write knowledge base content from outside the browser—ideal for backups, migrations, CI pipelines, and tools like n8n or custom MCP servers.
Documentation is evolving
The Open API is actively expanding. Export and import are available today; more endpoints and guides will be added here as they ship.
Authentication
All machine-facing endpoints use Bearer authentication with a user API key:
Authorization: Bearer YOUR_API_KEY- Sign in and open Settings → API Keys.
- Create a key and copy it immediately—the full secret is shown only once.
- Send the key on every request. Keys act on behalf of your account; they do not use browser session cookies.
Keep keys secret
Anyone with your API key can access knowledge bases you own when they know the slug. Revoke and recreate keys if they are exposed.
Base URL and route prefix
| Context | Value |
|---|---|
| Open API prefix | /api/v1/open/* |
| Browser / session routes | /api/books/* (login cookie required—do not use from scripts) |
Replace https://your-domain.com in examples with your deployment origin (for example http://localhost:3000 locally).
Available endpoints
| Endpoint | Method | Description |
|---|---|---|
| Export knowledge base documents | GET | List all active documents in an owned knowledge base, with plain text and optional HTML bodies |
| Import a document | POST | Create a new document from Markdown, HTML, or ProseMirror JSON |
Each knowledge base has a book slug in its URL—for example /app/books/a1b2c3d4 → slug a1b2c3d4.
Quick start
Export every document in a library:
curl -sS \
-H "Authorization: Bearer YOUR_API_KEY" \
"https://your-domain.com/api/v1/open/books/BOOK_SLUG/docs"Import a Markdown file as a new document:
curl -sS -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"My doc","format":"markdown","content":"# Hello\n\nBody."}' \
"https://your-domain.com/api/v1/open/books/BOOK_SLUG/docs/import"See the linked API pages for query parameters, response fields, and error codes.
What's coming
Planned additions to this documentation and the Open API include:
- Updating and deleting documents via API
- Pagination for large exports
- Webhooks and event subscriptions
- Additional integration guides and SDK examples
Check back here or watch release notes for updates.
Export documents
GET all active documents from an owned knowledge base.
Import a document
POST Markdown, HTML, or ProseMirror JSON to create a new doc.
Manage API keys
Create and revoke keys in the signed-in app.
OpenAPI
When enabled on your deployment, admins can browse merged routes at OpenAPI (/api/docs). Open API routes are tagged Open API · Books and share the /api/v1/open/* prefix.