Quick start
Create a personal access token, make a first request, and do the same through the SDK.
The fastest way to try the API is a personal access token: a scoped credential that acts as you. Shared or production automations should use a bot instead, and AI assistants should connect through the MCP server.
Base URLs
| Purpose | URL |
|---|---|
| REST API (personal access tokens) | https://api.nurama.com/v1 |
| REST API (bot API keys) | https://bot.nurama.com/v1 |
| WebSocket (personal access tokens) | https://ws.nurama.com (Socket.IO) |
| WebSocket (bot API keys) | https://bot-ws.nurama.com (Socket.IO) |
| MCP server | https://mcp.nurama.com/mcp |
All REST paths in this documentation are relative to the /v1 prefix. Requests and responses are JSON unless an operation says otherwise.
1. Create a token
In the Nurama web app open Settings → Tokens → New token. Give it a name and pick the scopes it needs. For a first look, workspaces:read and projects:read are enough. The token starts with nrm_pat_ and is shown once; store it like a password.
2. Make a request
curl -s https://api.nurama.com/v1/workspaces \
-H "Authorization: Bearer $NURAMA_TOKEN"The response lists the workspaces you belong to. A request outside the token's scopes fails with 403 and the error key forbidden; see Conventions for the error shape.
3. The same thing with the SDK
pnpm add @nurama/sdkimport NuramaClient from '@nurama/sdk';
const client = new NuramaClient('https://api.nurama.com', {
apiKey: process.env.NURAMA_TOKEN,
});
const workspaces = await client.workspace.listWorkspaces();With apiKey set, the client sends the token on every request and skips session handling entirely. Continue with the SDK guide.