Installation

Install

Choose the command for your package manager:

pnpm add @nirmos/sdk

npm install @nirmos/sdk

yarn add @nirmos/sdk

The package includes ESM, CommonJS, and TypeScript declarations. It has no runtime dependencies.

Create an API key

Create an API key in the Nirmos dashboard for the organization and environment your application will use. Store it in your deployment platform's secret manager.

NIRMOS_API_KEY=nirmos_your_key

Never prefix a browser-visible variable with NEXT_PUBLIC_, VITE_, or an equivalent public marker.

Initialize a client

Create one client and reuse it throughout the process:

import { Nirmos } from "@nirmos/sdk";

export const nirmos = new Nirmos({
  apiKey: process.env.NIRMOS_API_KEY!,
});

Default configuration:

Use a custom API origin for local development or a private Nirmos deployment:

const nirmos = new Nirmos({
  apiKey: process.env.NIRMOS_API_KEY!,
  baseUrl: "http://localhost:4000",
  timeoutMs: 30_000,
});

CommonJS

const { Nirmos } = require("@nirmos/sdk");

const nirmos = new Nirmos({
  apiKey: process.env.NIRMOS_API_KEY,
});

Next step

Continue to the quickstart to make a request.