Skip to content

Entitlements

NEXUS checks a small set of cloud-issued entitlements to decide which local capabilities are available. The cloud is not involved in the capabilities themselves — canvas writes, mesh messages, and terminal sessions all happen locally — only in granting or withholding the entitlement that unlocks them.

Endpoint

GET /api/v1/nexus/entitlements
Authorization: Bearer <token>

Response

json
{
  "nexus.desktop": true,
  "nexus.mcp_sync": true,
  "nexus.wiki": true,
  "nexus.files": true,
  "nexus.neural_map": true,
  "nexus.room": true,
  "nexus.music.player": false,
  "nexus.canvas": true,
  "nexus.browser": false,
  "nexus.orchestration": false,
  "nexus.sessions.max": 8,
  "nexus.agents.max": 20,
  "nexus.workspaces": 3
}

Keys

KeyKindGates
nexus.desktopbooleanRunning the desktop application at all.
nexus.mcp_syncbooleanThe local MCP server.
nexus.wikibooleanThe per-agent wiki surface.
nexus.filesbooleanFile surfaces.
nexus.neural_mapbooleanThe neural map view.
nexus.roombooleanThe room surface.
nexus.music.playerbooleanThe music player surface.
nexus.canvasbooleanThe collaborative canvas and its canvas_* tools.
nexus.browserbooleanA browser capability. Roadmap — this key exists so the gate is already in place; the capability itself has not shipped.
nexus.orchestrationbooleanOne of the two independent gates required before autonomous agent chains can form. See Explanation: Orchestration Governance.
nexus.sessions.maxlimitMaximum concurrent terminal sessions.
nexus.agents.maxlimitMaximum agents in a workspace.
nexus.workspaceslimitMaximum workspaces.

Propagation delay

Entitlement responses are served from a cached snapshot. A newly granted key can take up to 300 seconds to appear in this endpoint's response. Do not treat an entitlement that was just granted and still reads false (or a limit still at its old value) as a bug — poll or wait rather than escalating immediately.

Built with purpose.