Installation

Install the KiBee SDK in your project.

npm / yarn / pnpm

Terminal
npm install @kibee/sdk @kibee/renderer-three
# or
yarn add @kibee/sdk @kibee/renderer-three
# or
pnpm add @kibee/sdk @kibee/renderer-three

Import and Initialize

TypeScript
import { KiBeeClient } from "@kibee/sdk";
import { ThreeBeeRenderer } from "@kibee/renderer-three";
import "@kibee/renderer-three/styles.css";

const kibee = new KiBeeClient({
  renderer: new ThreeBeeRenderer({
    dockPosition: "bottom-right", // or "bottom-left", "top-right", "top-left"
    dockSize: 60,
  }),
  apiBaseUrl: "https://api.kibee.ai", // your KiBee API endpoint
});

await kibee.init();

SDK Authentication

The SDK authenticates via an X-KiBee-Key header sent with every API request. Get your API key from Settings → API Keys in the Admin Console.

Bundle Size

PackageSize (gzipped)Purpose
@kibee/sdk~8 KBCore runtime, flow engine, targeting
@kibee/renderer-three~45 KB3D bee renderer (Three.js + GSAP)
@kibee/contracts~1 KBTypeScript types (dev only)

The renderer loads asynchronously and does not block your main thread.