AI Assistant SDK for Your Website
Integrate an interactive 3D assistant with the official AI assistant SDK. Built for developers, the Asiyst AI avatar JavaScript SDK and AI assistant API make it easy to embed conversational 3D avatars, custom knowledge grounding, and UI guidance into any web application.
Quickstart Installation
Install the official npm package or include the CDN script tag.
npm install @asiyst/sdkimport { Asiyst } from "@asiyst/sdk";
// Initialize the assistant with your public project key
const asiyst = new Asiyst({
projectId: "proj_your_project_id",
position: "bottom-right",
theme: "dark",
onReady: () => {
console.log("Asiyst AI Assistant initialized successfully");
},
});npx @asiyst/cli link --project proj_your_project_idEngineered for Modern Web Architecture
Clean developer ergonomics, zero styling collisions, and full event lifecycle hooks.
Shadow DOM Encapsulation
The SDK isolates all internal styling and canvas elements. Your global Tailwind, CSS modules, or CSS-in-JS remain 100% untouched.
CLI-First Workflows
Sync knowledge files, validate project settings, and run diagnostic health checks using @asiyst/cli authenticated with passkeys.
Event Streams & Hooks
Subscribe to onMessage, onNavigate, onGuideStep, and onAvatarStateChange callbacks to synchronize custom application state.
Looking for a step-by-step code tutorial?
Explore our dedicated JavaScript integration guide with React, Next.js, and script-tag patterns.
Frequently Asked Questions About the AI Assistant SDK
Answers to common SDK questions, package managers, and API capabilities.
Which JavaScript frameworks and environments are supported by the SDK?
The @asiyst/sdk package is compatible with Next.js (App and Pages Router), React 18 & 19, Vue, Nuxt, SvelteKit, Angular, and vanilla JavaScript applications. You can also load it via CDN script tag.
What is the bundle size and impact on Core Web Vitals?
The core client library is under 28 KB gzipped and is engineered to load asynchronously in an isolated Shadow DOM container. It does not block page parsing or degrade Largest Contentful Paint (LCP).
How does the Asiyst CLI interact with the Web SDK?
The @asiyst/cli allows developers to authenticate securely, link local projects via 'npx @asiyst/cli link', validate configuration keys, and synchronize knowledge base files directly from the terminal or CI/CD pipelines.
Does Asiyst offer server-side APIs in addition to the client SDK?
Yes. Asiyst provides REST API endpoints for server-side assistant provisioning, project management, document ingestion, and telemetry event streaming.
How are API and SDK requests billed?
Requests utilize AI credits ($1.00 USD = 1,000 credits). New accounts receive 1,000 free starter credits. If you use Bring Your Own Key (BYOK) mode with your own OpenAI, Anthropic, or Google Gemini keys, 0 Asiyst credits are charged for model token usage.
Build with the Asiyst AI Assistant SDK
Get 1,000 free starter credits. Install the npm package, link your project, and embed a smart 3D assistant in minutes.