Chat Components

Overview

Copy page

Pre-built chat components to integrate Inkeep agents into your application

The Inkeep chat components provide pre-built UI elements to quickly integrate conversational AI into your application. These components handle the chat interface, message streaming, and user interactions out of the box.

Available Components

ComponentDescription
Chat ButtonA floating button that opens a chat modal
Custom TriggerUse your own button or element to trigger the chat
Side Bar ChatA chat panel that slides in from the side
Embedded ChatA chat component embedded directly in your page

Installation

Framework Support

The chat components are available for:

  • React - Native React components with full TypeScript support
  • JavaScript - Vanilla JavaScript for any framework or plain HTML

Automatic Headers

The chat components automatically send the following headers with each request to provide client context:

HeaderDescriptionExample Value
x-inkeep-client-timestampThe client's current timestamp in ISO 8601 format2025-01-30T18:15:00.000Z
x-inkeep-client-timezoneThe client's timezone identifierAmerica/New_York

These headers enable your agents to provide time-aware responses. See Headers to learn how to use these values in your agent configuration.

Customization

Learn how to customize the appearance and behavior of chat components in the Styling guide.