Skip to content

On-screen assistant SDK

Installing and initializing the SDK

Add the SDK script right below your widget snippet (manual 06), and call initCopilot with your manifest:

<script src="https://widget.example.com/v1/copilot-sdk.js"></script>
<script>
window.Copilot.initCopilot({
manifest: myManifest, // your v1 object, see section 5
allowedWidgetOrigins: ["https://widget.example.com"], // required
confirmOnFill: false, // optional: also require confirmation on fill
locale: "en", // optional: "es" | "en" | "it"
theme: "light", // optional: "light" | "dark"
});
</script>

Note — This example’s name and domain are illustrative

The real script your provider serves, and the global name it exposes, aren’t customized per white-label brand in this version of the product — copy it exactly as it appears in your own “Copilot” section (manual 58, section 2), don’t write it by hand from this example.

allowedWidgetOrigins is required: without it, the SDK doesn’t even start (it throws an error). It’s the list of origins your widget is allowed to send plans to the SDK from — any message from another origin is silently discarded (with a console warning).

Notice — Test before publishing

The SDK ships with a factory test site: a real form with a sample manifest and a simulated widget that sends plans through the exact same contract your real widget would use. Ask your provider for the link to that test site — it lets you test your anchors and your manifest without touching production, before registering anything.