SDK Overview - OnlookAI

Installation

npm install @onlook/core

Exports

Export	Description
`track(userId, config?)`	Start a session and return a `Session` object
`Session`	Class with `.on()`, `.stop()`, `.score`
`OnlookConfig`	TypeScript type for configuration
`AttentionEvent`	TypeScript type for signal events

Configuration

interface OnlookConfig {
  context?: string         // Label for this surface (default: window.location.pathname)
  threshold?: number       // Intervention trigger score (default: 40)
  ingestUrl?: string       // Custom ingest endpoint for self-hosting
  interventionCooldown?: number  // Seconds between interventions (default: 60)
  signals?: {
    face?: boolean         // Enable face detection (default: false)
    idle?: number          // Idle timeout in seconds (default: 30)
  }
}

Pages

track()

Start a tracked session.

Session

Session object methods and properties.

Events

All signal and lifecycle events.