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.

Rapid Development Phase

Nimi's app-facing contracts are usable, but they are still evolving quickly. Follow the current SDK and runtime spec, prefer createPlatformClient() as the high-level entrypoint, and avoid treating backlog items under spec/future/ as committed delivery.

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 platform client

import { createPlatformClient } from '@nimiplatform/sdk';

const { runtime } = await createPlatformClient({
  appId: 'docs.app-dev.quickstart',
});

3. Generate

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

Minimal working example

import { createPlatformClient } from '@nimiplatform/sdk';

const { runtime } = await createPlatformClient({
  appId: 'docs.app-dev.minimal',
});
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