For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GitHubGet Support
DocsGuidesAPI Reference
DocsGuidesAPI Reference
LogoLogo
GitHubGet Support
On this page
  • Quick links
  • Core capabilities
  • What you can build
  • Get your credentials
  • Installation
  • Integration
  • Get support
Get Started

Welcome to Sunny Agents SDK

Build healthcare concierge experiences with AI-powered chat

||View as Markdown|
Was this page helpful?
Built with

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

Overview

Understand what you can build with the Sunny Agents SDK

Quickstart

Get up and running in minutes

Authentication

Set up authenticated sessions

API Reference

REST and WebSocket API schemas

Core capabilities

Build rich chat experiences with these integrated capabilities:

CapabilityWhat you can do
MessagingSend messages and receive streaming responses in real-time
ConversationsManage multiple conversations with state persistence
AuthenticationSecure token exchange for authenticated sessions
ArtifactsParse and render rich content delivered inline in messages

New to the Sunny Agents SDK? Start with the Overview to understand the platform, then follow the Quickstart to make your first API call.

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, the partner portal. Sign in at platform.sunnyhealthai.com (or staging) and go to Developer Tools to create an API key and view your partner name.

Installation

Get started in seconds:

$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:

1import { createSunnyChat } from "@sunnyhealthai/agents-sdk";
2
3const chat = createSunnyChat({
4  container: document.getElementById("chat"),
5  partnerIdentifier: "acme-health",
6  publicKey: "pk-sunnyagents_abc_xyz",
7  authType: "passwordless", // or "tokenExchange"
8});
9
10// Access the client for programmatic control
11chat.client.on("snapshot", (snapshot) => { /* ... */ });
12
13// Clean up when done
14chat.destroy();

Get support

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

  • Documentation issues - Open an issue on GitHub
  • General support - Email our team
  • TypeScript types - Full type definitions included

Need help? Check out our Quickstart guide to get started, or browse the API Reference for token exchange and message schemas.