Overview
The official Nimobase SDK is the recommended way to consume the REST API: typed clients, consistent errors, and authentication that matches where your code runs. It wraps the whole API — it already paginates and translates errors for you — from your server or from your users' browsers, without exposing secrets.
Where does your code run?
| Where | Credential | Package |
|---|---|---|
| On your server (backend, scripts, jobs) | Secret key sk_ | @nimobase/sdk/node |
| In the browser (SPA, embedded widget) | Publishable key pk_ + user JWT | @nimobase/sdk/browser |
The TypeScript package is the same for both surfaces — only the import changes (@nimobase/sdk/node or @nimobase/sdk/browser). If the integration runs on a server and you prefer Python, there is a Python SDK.
Never expose secret keys
sk_ keys must not be used in browsers or mobile apps. The browser SDK rejects sk_ at initialisation time (fail-fast), and the server SDK rejects pk_. Keys are created and managed in API Keys.
Installation
The package is published to GitHub Packages, not to public npm. First create a GitHub PAT with the read:packages scope, then declare the registry in your project's .npmrc:
# project .npmrc
@nimobase:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
npm install @nimobase/sdkNODE_AUTH_TOKEN is an environment variable holding the PAT. Without that token npm install fails: GitHub Packages does not serve packages unauthenticated.
Continue here
Once you know what the SDK is and how to install it, carry on with the TypeScript SDK or the Python SDK, depending on where your integration runs. And when you want to see what each of those surfaces can do, the full index of capabilities is in Features and methods.