Authentication

Every request to the nXus API must include your API key in the Authorization header as a Bearer token. Keys are scoped to an organization and optionally to a specific environment (development or production).

import { NxusClient, NxusApiError, type Vendor, type PaginatedPage } from '@nxus/sdk';

const nxus = new NxusClient({ apiKey: process.env.NXUS_API_KEY });

try {
  const result: PaginatedPage<Vendor> = await nxus.vendors.list({
    connectionId: 'conn_abc123',
    limit: 50
  });
  console.log(result.data);
} catch (err) {
  if (err instanceof NxusApiError) {
    console.error(`API Error: ${err.userMessage}`);
    console.log(err.validationErrors);
  }
}

Key Types

Managing API Keys

Create, view, revoke, and rotate keys from the dashboard under Settings -> API Keys.

API-key management is no longer part of the public API reference. Those operations are handled by the authenticated dashboard and our internal platform client instead of public API requests.

Key Expiry

Keys can be configured with an optional expiry date. After expiry, requests return a 401 Unauthorized response. Plan ahead and rotate before expiry using the rotate endpoint or the dashboard.

Error Responses

{
  "error": {
    "code": "api_key_invalid",
    "type": "authentication_error",
    "message": "The provided API key is invalid or has been revoked.",
    "userFacingMessage": "Your API key is no longer valid. Create or rotate a key and try again.",
    "httpStatusCode": 401
  }
}