> This page is for version v8.3.0 (default).
> For other versions, use one of these documentation indexes:
> - v8.3.0 (default): https://docs.workflows.com/v-8-3-0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.workflows.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.workflows.com/_mcp/server.

# MindSim Node.js / TypeScript SDK

> Overview of the official MindSim SDK for Node.js environments.

# MindSim Node.js SDK

The official MindSim TypeScript SDK allows you to programmatically create digital minds, populate them with conversational data, and run powerful simulations to get an accurate preview of how a person will think, feel, say, and act in any scenario.

## Installation

The SDK requires **Node.js version 24** or higher.

To install the SDK in your project:

**`npm`**

```shell npm
npm install mindsim
```

**`yarn`**

```shell yarn
yarn add mindsim
```

**`pnpm`**

```shell pnpm
pnpm add mindsim
```

To install the CLI tool globally (useful for authentication):

```bash
npm install -g mindsim
```

## Why use the SDK?

While the MindSim API is accessible via standard HTTP requests, the SDK provides several distinct advantages for developers:

1. **Type Safety**: Written in TypeScript, the SDK exports interfaces for all requests and responses (e.g., `Mind`, `Simulation`, `SnapshotStatus`). This ensures autocomplete support in your IDE and catches errors at compile time.
2. **Simplified File Uploads**: The SDK abstracts away the complex logic required for uploading large training files, handling signed URLs, binary streams, and multipart form data automatically.
3. **Automatic Authentication**: Integrates seamlessly with the CLI's `mindsim auth` command for local development without needing to manually manage bearer tokens.
4. **Update Notifications**: The SDK automatically checks for critical updates, ensuring you are using the most accurate simulation models available.