> ## Documentation Index
> Fetch the complete documentation index at: https://snowglobe.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview & Installation

> Understand what the `snowglobe sdk` for typescript is, when to use it, and the end-to-end flow to get your chatbot connected to Snowglobe.

The Snowglobe SDK for Typescript allows fine grained, programmatic control of your Agents and Simulations.

## When to use the Snowglobe SDK

Use this flow when you want to:

* Programmatically interact with individual endpoints of the Snowglobe API
* Programmatically perform individual CRUD operations on your Agents and Simulations in your Typescript code.

DO NOT use this flow when you want to:

* Connect an existing chatbot to Snowglobe for processing synthetic conversations from a Simulation
* Perform complex workflows with minimal or guided input

## Prerequisites

* Node.js v20.x+ or similar (e.g. Bun v1.x+)
* macOS, Linux, or Windows

## Installation

Install the package using your preferred package manager:

```bash theme={null}
npm install @guardrails-ai/snowglobe-sdk
# or
yarn add @guardrails-ai/snowglobe-sdk
# or
bun add @guardrails-ai/snowglobe-sdk
```