Smart365Guide
Documentation

Developer Docs

Everything you need to integrate Smart365Guide into your product.

Quickstart

1. Add the script tag

Add this one line to your HTML before the closing </body> tag:

<script src="https://cdn.smart365guide.com/sdk.js" data-key="YOUR_API_KEY"></script>

2. Or install via npm

npm install @smart365guide/sdk
import { Smart365Guide } from '@smart365guide/sdk';

Smart365Guide.init({
  apiKey: 'YOUR_API_KEY',
  environment: 'production',
});

3. React integration

import { Smart365GuideProvider } from '@smart365guide/react';

function App() {
  return (
    <Smart365GuideProvider apiKey="YOUR_API_KEY">
      <YourApp />
    </Smart365GuideProvider>
  );
}

4. Verify

Open your app in the browser and press F1 . If you see the Smart365Guide widget appear, you're all set!

SDK Reference

Smart365Guide.init(config)

Initialize the SDK with your API key and configuration options.

Smart365Guide.identify(user)

Identify the current user for personalized guidance and analytics.

Smart365Guide.startWorkflow(id)

Programmatically start a specific workflow for the user.

Smart365Guide.on(event, callback)

Listen for SDK events like help requests, completions, and errors.

Smart365Guide.setMode(mode)

Switch between "explain", "guide", and "do" modes.

Smart365Guide.destroy()

Cleanly unmount the widget and remove all listeners.

Workflow Setup

Workflows define what the AI teaches to your users. You can create them from your dashboard:

  1. Go to Dashboard → Workflows
  2. Click New Workflow
  3. Record steps using the browser recorder or define them manually
  4. Mark each action as safe or requires approval
  5. Publish the workflow to make it available to users

Desktop Agent

The optional desktop agent extends Smart365Guide to native applications on Windows and Linux.

  1. Download the agent from your Dashboard → Downloads
  2. Install on the target machine
  3. Enter the activation key from your dashboard
  4. The device will appear in Dashboard → Licenses → Devices