Contents
Every public page, grouped by what you are trying to do. Expand a section, or press / (or the search box) to search the whole reference.
Start here
- Choose your path — Every path leads to the same platform.
- What is Nimobase? — Nimobase is the foundation you build your digital product on.
No-Code
- Create apps without code — The dashboard is where the application comes together without writing a line of code: you model the data, declare the screens and flows, and publish…
Use MCP
- MCP server — The Nimobase MCP server connects your AI agent — Claude Code, Cursor, Codex, opencode, Cline — to your company.
Use the SDK
- Overview — The official Nimobase SDK is the recommended way to consume the REST API: typed clients, consistent errors, and authentication that matches where…
- Python SDK — The official Nimobase SDK for Python (3.10+) is the alternative to the TypeScript SDK when your integration runs on a server.
- TypeScript SDK — You already installed @nimobase/sdk (see Overview).
Use the API
- Use our API — The REST API is the platform's raw surface: every capability, exposed as its endpoints as-is.
Features and methods
- Features and methods — This is the index of the platform's features.
Access and accounts
- API Keys — API Keys let external applications consume our API without using a person's credentials.
- Authentication — It manages access to the system.
- Companies — It manages the system's companies (tenants) and their members.
- Invitations — It lets a company's administrators invite new members through a link/token sent by email.
- OAuth 2.0 Authorization Server — The OAuth 2.0 authorization server lets third-party applications and native apps obtain scoped access tokens on behalf of users, without exposing…
- Users — It manages the system's user accounts.
Money and taxation
- Billing and subscriptions — The billing module manages plans, prices, subscriptions and access to paid features.
- Clients (commercial billing) — Clients are the recipients of a company's commercial documents.
- Commercial documents — Lifecycle of commercial billing documents per company: draft → issuance, credit notes, proforma or quote → invoice conversion, automatic generation…
- Document types, series and sequential numbers — Configuration of a company's commercial document types: invoice, credit note, proforma, quote or custom ones, each with at least one series and a…
- Fiscal catalogue / tax engine — Versioned catalogue of jurisdictions and taxes.
- Owner resale plans (Owner Plans) — This module lets a company owner define their own plan catalogue to resell to their own end customers — for example, an agency using Nimobase to…
Data, files and AI
- AI module — The AI module lets you talk to several artificial intelligence providers in a decoupled way.
- Application DSL (single document: screens, roles and flows) — The Application DSL is the application layer built on top of the Entity Manager: a single JSON document per published version that declares the…
- Document RAG for assistants — It lets assistants answer using the tenant's own knowledge: the user links files already uploaded to the bucket to a specific assistant, the system…
- Entity Manager (definitions, follows, instances and relations) — The Entity Manager is Nimobase's data layer: it lets you declare entities with a field schema, version them and publish them into a platform or…
- Object storage — It exposes a free bucket (object space) for the platform and for each tenant, operable with listing, upload, download, delete, rename/move, folder…
Publish and operate
- Domains and internal DNS connections — The module manages hostname ownership and access to the DNS zones authorized for NimoApps.
- Event logger (UI click analytics) — This module records interface click and interaction events and exposes aggregated rankings per company.
- Feedback (beta tester widget) — This module receives the feedback users send from the floating widget that appears across the whole application.
- Native feature flags — Feature flags turn a capability of an app on or off without publishing a new version.
- NimoApps static artifacts — Deployments are accepted as durable operations under /app-operations.
- Notifications — The notification system sends alerts to users across several channels when relevant platform events happen.
- Projects, environments and releases — This internal API prepares deployable applications without altering the DSL catalogue or publishing infrastructure.
- Webhooks — The webhooks module receives and processes events from external providers (payments, communications, etc.) generically and extensibly.
Concepts
- Company ownership lifecycle — This page documents what happens when someone registers, who owns which company, the difference between "the default company" and a company created…
- Environments — Nimobase runs in two environments: Production and Sandbox.
- Multi-tenancy — The system is designed so that several companies share one deployment without their data mixing.
- Roles and permissions — Each user has a different role in each company they belong to.
- System events — When something important happens (a user is created, someone accepts an invitation…), the module responsible emits an internal event.