Configuration Reference

SDK Configuration

Complete Asiyst.init() options:

interface AsiystInitOptions {
  // Required
  projectId: string;
  publicKey: string;
  // Environment
  environment?: "development" | "production";
  locale?: string;                 // e.g., "en-US"
  debug?: boolean;
  // Avatar
  avatarId?: string;
  avatar?: {
    autoShow?: boolean;            // Default: true
    showDelay?: number;            // ms, default: 0
    idleTimeout?: number;          // ms, default: 60000
    enableGuidance?: boolean;      // Default: true
    anchor?: "bottom-right" | "bottom-left" | "bottom-center";
    disableDefaultClickBehavior?: boolean;
  };
  // Session
  session?: {
    persist?: boolean;             // Default: true
    timeout?: number;              // ms, default: 1800000 (30min)
  };
}

Project Configuration

asiyst.config.json schema:

{
  "projectId": "proj_abc123",
  "environment": "development",
  "avatarId": "avt_abc123",
  "knowledgeCollectionId": "col_xyz",
  "allowedDomains": ["example.com"],
  "knowledgeSources": ["src_01"]
}