Build on Nexus.

Programmatic access to your workspace — read nodes, create documents, automate workflows. The API is in early beta.

The REST API is in beta. Endpoints and authentication may change with notice.

Authentication

All API requests are authenticated using a Bearer token. Generate a personal access token from your workspace settings.

Tokens are scoped to a single workspace and inherit the requesting user's permissions. Treat them like passwords — store securely, rotate regularly.

All API traffic is over HTTPS. Requests over HTTP are rejected.

Request example

curl https://api.usenexus.app/v1/nodes \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "node_01abc...",
      "type": "document",
      "title": "Launch Plan",
      "parent_id": null,
      "created_at": "2025-04-01T10:00:00Z"
    }
  ],
  "total": 42
}

Endpoints

Base URL: https://api.usenexus.app

GET/v1/workspacesList workspaces the authenticated user belongs toBeta

GET/v1/workspaces/:id/nodesList all nodes in a workspaceBeta

GET/v1/nodes/:idGet a single node with its metadataBeta

POST/v1/nodesCreate a new node (document, folder)Beta

PATCH/v1/nodes/:idUpdate node metadata (title, parent, position)Beta

DELETE/v1/nodes/:idDelete a node and its childrenBeta

GET/v1/nodes/:id/contentExport node content as JSON or MarkdownComing soon

GET/v1/workspaces/:id/membersList workspace membersComing soon

Resources

Full reference

Complete endpoint documentation with examples, request/response schemas, and error codes.

Read the docs →

TypeScript SDK

Official SDK for Node.js and browser environments. Typed, tree-shakeable, actively maintained.

Coming soon

Webhooks

Receive real-time notifications when nodes are created, updated, or deleted in your workspace.

Coming soon

API questions? api@usenexus.app