Skip to content

Management SDK

Install and configure the generated TypeScript client for all 55 Nexus Admin operations.

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

The Management SDK configures Nexus through the Admin API. It does not wrap model requests and does not reproduce server-side access, quota, or ProviderConnection decisions.

Install

pnpm add @nexus/sdk-typescript

The package is currently a workspace-private Beta artifact. The import name above is the accepted package contract; public registry coordinates remain a release decision.

Create a client

import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: process.env.NEXUS_ADMIN_BASE_URL ?? 'http://localhost:3000',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

The SDK uses Web Standard fetch, accepts an injectable Fetch implementation, and exposes typed methods for every Admin operationId.

Learn the cross-cutting behavior

Generated method groups

Each signature and API link is regenerated from the accepted Admin OpenAPI document and the checked-in client. The freshness check fails if either source changes independently.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close