​
Installation

Integrating Lumen on your website is quick and easy. After signing into your Lumen dashboard, you’ll find the installation script on your dashboard home.

To install, simply paste the installation script inside the <body> tag of your website. The script looks similar to this:

<script
  data-agent-id="<YOUR-AGENT-ID>"
  src="https://widget.uselumen.co/static/widget-v1.js"
></script>

That’s it! Your AI agent is now live on your website.

​
Customization

You can set custom options for your agent’s appearance and behavior by defining a lumenSettings object on your window scope:

<script>
  window.lumenSettings = {
    position: "center",
    hideDefaultLauncher: true,
    showBackdrop: true,
    onReady: () => {
      console.log("ready");
    },
  };
</script>

<!-- Installation script here  -->

Note that window.lumenSettings must be defined before the agent installation script loads for it to take effect.

​
Parameters

​
position
string

Sets the widget’s position. Options are center or default.

​
hideDefaultLauncher
boolean

Set to true to hide the default floating launcher at the bottom right of the page.

​
showBackdrop
boolean

Set to true to display a backdrop overlay behind the chat widget.

​
onReady
function

Callback function that runs when the widget is ready.

​
Using Lumen on your mobile app

For integrating your AI agent into native mobile apps, you can use a WebView.

Official mobile app packages are coming soon, so stay tuned for updates.


Custom launcher button

Supercharge your AI agent by setting up “Actions”

IntroductionKnowledge Base