App Developer Overview

Nimi gives app developers a single runtime and a single SDK (@nimiplatform/sdk) to work with both local and cloud AI models. Write your integration once, then switch between on-device inference and remote providers without changing application code.

Prerequisites

• Nimi installed and running -- start the runtime with nimi start.
• Node.js (v18+) for the SDK.

Quick Path

1. Install the SDK

npm install @nimiplatform/sdk

2. Create a Runtime instance

import { Runtime } from '@nimiplatform/sdk/runtime';

const runtime = new Runtime();

3. Generate

const result = await runtime.generate({ prompt: 'What is Nimi?' });
console.log(result.text);

Minimal working example

import { Runtime } from '@nimiplatform/sdk/runtime';

const runtime = new Runtime();
const result = await runtime.generate({ prompt: 'What is Nimi?' });
console.log(result.text);

Next Steps

• SDK Setup -- Install the SDK and run your first example
• App Developer Guide -- Integration patterns and scaffold
• Recipes -- Runnable building blocks
• Production Checklist -- Ship with confidence
• SDK Reference -- API surface
• Error Codes -- Structured error handling
• Provider Matrix -- Available providers