Skip to content

API Overview ​

The Nexus API provides programmatic access to documentation search, memory, and server registry.

Base URL ​

https://api.nexus.yogan.dev

Authentication ​

API Key Required
All API and MCP tool calls require an API key. Get one by running `npx @nexus/cli auth login` or at [nexus.yogan.dev/dashboard/keys](https://nexus.yogan.dev/dashboard/keys).

Include your API key in the Authorization header:

Authorization: Bearer nxs_your_api_key_here

See the Authentication Guide for detailed setup instructions.

MCP Endpoint ​

For MCP clients (AI assistants), use:

https://api.nexus.yogan.dev/mcp

Configure your MCP client with the Nexus CLI:

json
{
  "mcpServers": {
    "nexus": {
      "command": "npx",
      "args": ["-y", "@nexus/cli", "serve"],
      "env": {
        "NEXUS_API_KEY": "nxs_your_api_key_here"
      }
    }
  }
}

REST Endpoints ​

Documentation ​

MethodEndpointDescription
GET/librariesList libraries
GET/libraries/:idGet library info
POST/libraries/:id/querySearch documentation

Memory ​

MethodEndpointDescription
GET/memoriesList memories
POST/memoriesCreate memory
GET/memories/:idGet memory
PATCH/memories/:idUpdate memory
DELETE/memories/:idDelete memory
POST/memories/searchSearch memories

Servers ​

MethodEndpointDescription
GET/serversList servers
GET/servers/:idGet server info
GET/servers/:id/configGet install config

Response Format ​

All responses are JSON:

json
{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123"
  }
}

Errors ​

json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Library not found"
  }
}

Authentication Errors ​

json
{
  "error": {
    "code": -32001,
    "message": "API key required. Get your API key at https://nexus.yogan.dev/dashboard/keys or run: npx @nexus/cli auth login"
  }
}

Rate Limits ​

PlanRequests/Month
Free2,000
ProUnlimited
TeamUnlimited

See Rate Limits for details.

Released under the MIT License.