SDK Lifecycle

The Adopt AI SDK includes a set of methods that let you control when and how the Agent Experience appears inside your app.

Lifecycle Methods Covered

init()
boot()
shutdown()
setUserProperties()

1. `init()`

Used only with the NPM package. Initializes the SDK with your license key and optional configuration (like CSP settings).

NPM Package:

import { init } from '@adoptai/sdk';

init('your-license-key');

Optional config:

init('your-license-key', {
  nonce: 'abc123' // For Content Security Policy support
});

**Important **- You must call init() before using boot() or any other method.

2. `boot()`

Starts the Copilot for a logged-in user. This is what makes the agent visible and interactive.

Script/CDN:

window.AdoptAI.boot('user-123', {
  name: 'John Doe',
  email: 'john@example.com'
}, {
  products: ['sidebar', 'spotlight']
});

NPM Package:

import { boot } from '@adoptai/sdk';

boot('user-123', {
  name: 'John Doe',
  email: 'john@example.com'
}, {
  products: ['sidebar', 'spotlight'],
  apiBaseUrl: '<https://api.yourapp.com>',
  appBaseUrl: '<https://yourapp.com>',
  copilotHeaders: {
    'Authorization': 'Bearer token123'
  }
});

Parameters:

userId – required (string): unique ID for the current user
userProperties – optional: user-level data (name, plan, etc.)
instanceAttributes – optional: product config, API URLs, and auth headers

3. `shutdown()`

Hides the Copilot from view. Usually called when the user logs out or switches accounts.

Script/CDN:

window.AdoptAI.shutdown();

NPM Package:

import { shutdown } from '@adoptai/sdk';

shutdown();

Best practice: always call shutdown() before calling boot() again for a different user.

4. `setUserProperties()`

Updates user properties after boot()—useful for real-time changes like plan upgrades or preference updates.

Script/CDN:

window.AdoptAI.setUserProperties({
  userProperties: {
    plan: 'enterprise',
    upgradeDate: new Date().toISOString()
  }
});

NPM Package:

import { setUserProperties } from '@adoptai/sdk';

setUserProperties({
  userProperties: {
    plan: 'enterprise',
    upgradeDate: new Date().toISOString()
  }
});

Summary Table

Method	Purpose	When to Use
`init()`	Initialize the SDK (NPM only)	On page load
`boot()`	Show the agent to the current user	After user login
`shutdown()`	Hide the agent	On user logout or session end
`setUserProperties()`	Update user data for the current session	When user attributes change in real time

Now that you know how to initialize and control the agent experience, you can move on to: Components → Learn how to enable and customize the Sidebar or Spotlight (or both) in your application. This is where you’ll decide how the Copilot appears to users—and how it fits into your product’s overall UX.

Our Products

Workflows & Use Cases

Features

Authentication

JavaScript SDK

API

Lifecycle Methods Covered

1. `init()`

NPM Package:

Optional config:

2. `boot()`

Script/CDN:

NPM Package:

3. `shutdown()`

Script/CDN:

NPM Package:

4. `setUserProperties()`

Script/CDN:

NPM Package:

Summary Table

​Lifecycle Methods Covered

​1. init()

​NPM Package:

​Optional config:

​2. boot()

​Script/CDN:

​NPM Package:

​3. shutdown()

​Script/CDN:

​NPM Package:

​4. setUserProperties()

​Script/CDN:

​NPM Package:

​Summary Table

Lifecycle Methods Covered

1. `init()`

NPM Package:

Optional config:

2. `boot()`

Script/CDN:

NPM Package:

3. `shutdown()`

Script/CDN:

NPM Package:

4. `setUserProperties()`

Script/CDN:

NPM Package:

Summary Table