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:

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

Desktop SDK

The public desktop SDK starter lets you embed Smart365Guide in Rust/Tauri, Rails, Python, .NET/C#, C++/Qt, Electron, WebView2, and other apps that render a web UI.

Rust / Tauri Rails Python / PySide6 .NET / C# / WebView2 C++ / Qt WebEngine

Download the public starter from /downloads/smart365guide-desktop-sdk-1.1.1.zip
Add smart365guide-desktop.js to your renderer process or load the hosted public script.
Initialize with your license key, app name, platform, and endpoint.
For Electron apps, use the included electron-preload.js bridge to expose safe native metadata to the renderer.

<script src="https://www.smart365guide.com/downloads/desktop-sdk/smart365guide-desktop.js"></script>
<script>
  Smart365GuideDesktop.init({
    licenseKey: "lk_your_license_key",
    endpoint: "https://www.smart365guide.com",
    appName: "Acme Desktop",
    platform: "electron"
  });
</script>