Overview
What the Nurama platform exposes to developers, which credential to use, and where to find each part.
Nurama is a collaborative asset-review platform: workspaces contain projects, projects contain assets, folders, boards, tasks and chats, and every change fans out to the people watching it in real time. This site documents how to build on it.
Pick a credential first
Integrations never sign in with a person's email and password. Each way of connecting has its own credential, and the credential decides what the connection can do.
| You are building | Use | Acts as |
|---|---|---|
| An AI assistant integration (Claude, Cursor, any MCP client) | The hosted MCP server with OAuth sign-in | The person who signed in, limited to the scopes they approved |
| A script or automation that should act as you | A personal access token | You, limited to the scopes on the token |
| A shared service, bot or team automation | A bot API key | A dedicated bot user with its own memberships and scopes |
All three are scoped, revocable and cannot touch billing, account security or token management.
The surfaces
MCP server
Connect an assistant to mcp.nurama.com and let it read and act on Nurama with scoped tools.
REST API
JSON over HTTPS under /v1. Generated from the OpenAPI document, with a playground on every operation.
WebSocket events
Socket.IO channels per resource. Every notification type, typing indicator and collab event.
Webhooks
Signed HTTP callbacks to your server when tasks, messages and assets change.
SDK
@nurama/sdk wraps the API and the socket layer for Node, browsers and bots.
Machine-readable sources
Everything on this site is generated from documents you can consume directly:
- OpenAPI 3.0:
/openapi.jsonor/openapi.yaml - AsyncAPI 3.0:
/asyncapi.jsonor/asyncapi.yaml - MCP tool catalogue:
/mcp-tools.json - This site as text for language models:
/llms.txt(index) and/llms-full.txt(everything). Every page also has a Markdown variant, reachable from the copy button at the top of the page.
The build manifest records which platform release the documents were generated from.