***

title: Welcome to Sunny Agents SDK
subtitle: Build healthcare concierge experiences with AI-powered chat
slug: welcome
---------------------

For clean Markdown of any page, append .md to the page URL. For a complete documentation index, see https://docs.sunnyhealthai.com/ask-sunny/llms.txt. For full documentation content, see https://docs.sunnyhealthai.com/ask-sunny/llms-full.txt.

The Sunny Agents SDK is a TypeScript/JavaScript library designed specifically for building healthcare applications. Embed AI-powered chat experiences that help patients find providers, book appointments, get health information, and navigate care—all in real-time.

## Quick links

<CardGroup cols={2}>
  <Card title="Overview" icon="duotone book-open" href="/overview">
    Understand what you can build with the Sunny Agents SDK
  </Card>

  <Card title="Quickstart" icon="duotone rocket" href="/quickstart">
    Get up and running in minutes
  </Card>

  <Card title="Authentication" icon="duotone lock" href="/authentication">
    Set up authenticated sessions
  </Card>

  <Card title="API Reference" icon="duotone code" href="/api-reference">
    REST and WebSocket API schemas
  </Card>
</CardGroup>

## Core capabilities

Build rich chat experiences with these integrated capabilities:

| Capability         | What you can do                                            |
| ------------------ | ---------------------------------------------------------- |
| **Messaging**      | Send messages and receive streaming responses in real-time |
| **Conversations**  | Manage multiple conversations with state persistence       |
| **Authentication** | Secure token exchange for authenticated sessions           |
| **Artifacts**      | Parse and render rich content delivered inline in messages |

<Tip>
  New to the Sunny Agents SDK? Start with the [Overview](/overview) to
  understand the platform, then follow the [Quickstart](/quickstart) to make
  your first API call.
</Tip>

## What you can build

* **Healthcare concierge applications** - Help patients find in-network providers and book appointments instantly
* **Provider search interfaces** - Enable patients to search for doctors by specialty, location, and availability
* **Health information assistants** - Provide reliable health information and support 24/7
* **Appointment booking systems** - Streamline appointment scheduling with AI-powered guidance
* **Benefits navigation tools** - Help employees and members understand and access their healthcare benefits

## Get your credentials

Before integrating, you need a **public key** and **partner identifier** from [Sunny Central](/partner-setup), the partner portal. Sign in at [platform.sunnyhealthai.com](https://platform.sunnyhealthai.com) (or [staging](https://platform.sunnyhealthai-staging.com)) and go to **Developer Tools** to create an API key and view your partner name.

## Installation

Get started in seconds:

```bash
npm install @sunnyhealthai/agents-sdk
# or
pnpm add @sunnyhealthai/agents-sdk
# or
yarn add @sunnyhealthai/agents-sdk
```

## Integration

Use `createSunnyChat` to embed a fully-featured chat widget with automatic authentication and server-driven configuration:

```typescript
import { createSunnyChat } from "@sunnyhealthai/agents-sdk";

const chat = createSunnyChat({
  container: document.getElementById("chat"),
  partnerIdentifier: "acme-health",
  publicKey: "pk-sunnyagents_abc_xyz",
  authType: "passwordless", // or "tokenExchange"
});

// Access the client for programmatic control
chat.client.on("snapshot", (snapshot) => { /* ... */ });

// Clean up when done
chat.destroy();
```

## Get support

Have questions or need help? We're here for you:

* **Documentation issues** - [Open an issue on GitHub](https://github.com/sunnyhealthai/agents-sdk/issues)
* **General support** - [Email our team](mailto:support@sunnyhealthai.com)
* **TypeScript types** - Full type definitions included

***

<Tip>
  **Need help?** Check out our [Quickstart guide](/quickstart) to get started,
  or browse the [API Reference](/api-reference) for token exchange and message schemas.
</Tip>