Introduction

Yak is an AI-powered platform assistant that integrates into your web application, providing intelligent automation and user assistance directly within your product.

What is Yak?

Yak provides an embeddable AI assistant that:

• Understands your application – Connects to your data layer to provide contextual assistance
• Integrates seamlessly – Works with React, Next.js, Remix, Astro, and any JavaScript runtime
• Customizable – Adapt the assistant's behavior and appearance to match your brand
• Production-ready – Built for scale with enterprise-grade security and reliability

Key Features

• 🤖 AI-Powered Assistance – Natural language interaction with your application
• 🔌 Easy Integration – Drop-in components and server handlers
• 🛠️ Tool Adapters – Connect tRPC, GraphQL, REST APIs, and databases
• 🎨 Customizable UI – Match your brand and design system
• 🔒 Secure – Enterprise-grade security and data privacy

How It Works

Yak integrates into your application in three steps:

1. Install the SDK – Add Yak to your project with a single command
2. Set up server handlers – Configure routes and tools the AI can use
3. Embed the widget – Drop the AI assistant component into your UI

Quick Start

Choose your framework to get started:

• Next.js – Full-featured integration with App Router support
• React – Works with any React application
• JavaScript – Framework-agnostic SDK for any runtime

Architecture Overview

┌─────────────────────────────────────────────────────────────┐
│                     Your Application                        │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  ┌─────────────────┐    ┌─────────────────────────────────┐ │
│  │   YakProvider   │    │        Server Handlers          │ │
│  │   + YakWidget   │◄──►│  GET /api/yak → routes + tools  │ │
│  │                 │    │  POST /api/yak → execute tools  │ │
│  └─────────────────┘    └─────────────────────────────────┘ │
│                                    │                        │
│                                    ▼                        │
│                         ┌─────────────────────┐             │
│                         │    Tool Adapters    │             │
│                         │  tRPC, GraphQL, DB  │             │
│                         └─────────────────────┘             │
│                                                             │
└─────────────────────────────────────────────────────────────┘

The client-side widget communicates with your server handlers, which expose routes and tools to the AI. Tool adapters let you connect your existing APIs and data sources.