Embed on any site

Installation

Add the Omnific teaching assistant to your website or LMS. This demo uses the shared key below — sign up for your own API key and embed code.

Site API key

Your secret key that tells the API which chatbot to load (branding, FAQ, course content). Keep it private — do not commit it to public GitHub repos.

sk_coinnet_dev_embed_key

How to use this key

Option 1 — Embed script (recommended)

Add your key as the data-site-key attribute on the script tag. The widget sends it automatically on every API call — you do not need to write any JavaScript.

data-site-key="sk_coinnet_dev_embed_key"

Option 2 — Direct API calls (custom apps)

Send the key in the X-Site-Key HTTP header on every request to the backend API (https://your-api-host.com). Use this only if you are building your own UI instead of the embed widget.

Load widget settings

curl "https://your-api-host.com/api/widget/config" \
  -H "X-Site-Key: sk_coinnet_dev_embed_key"

Send a chat message (SSE stream)

curl -X POST "https://your-api-host.com/api/widget/chat" \
  -H "Content-Type: application/json" \
  -H "X-Site-Key: sk_coinnet_dev_embed_key" \
  -d '{"message":"Hello, what courses do you offer?"}'

Embed code

Paste this on any website where you want the chat bubble to appear.

Copy the script below.
Open your site's HTML (WordPress footer, Webflow custom code, LMS theme, etc.).
Paste it just before the closing </body> tag.
Save and reload the page — the chat launcher appears in the corner.

<script
  src="https://teach.omnitest.dev/embed.js"
  data-site-key="sk_coinnet_dev_embed_key"
  data-api-url="https://your-api-host.com"
  async
></script>

Show full HTML example

<!DOCTYPE html>
<html>
  <body>
    <h1>My website</h1>
    <!-- Your page content -->

<script
  src="https://teach.omnitest.dev/embed.js"
  data-site-key="sk_coinnet_dev_embed_key"
  data-api-url="https://your-api-host.com"
  async
></script>
  </body>
</html>

Script attributes

Attribute	Required	Description
data-site-key	Yes	Your site API key — identifies your bot
data-api-url	Yes	Backend API URL (`https://your-api-host.com`) — not your website URL
data-position	No	`bottom-right` (default) or `bottom-left`

What happens when someone visits your site

embed.js loads from https://teach.omnitest.dev/embed.js
It reads data-site-key and data-api-url from the script tag
It calls GET /api/widget/config with your key to load colours, welcome message, and quick replies
When a user sends a message, it calls POST /api/widget/chat with the same key

Troubleshooting: if the widget does not appear, check the browser console for errors and ensure your site domain is allowed. Upload content under Content and enable RAG in Chatbot settings.

Configure your bot

Create your site at /manage/signup — you get your own API key and embed snippet.
Customize chat name, colours, and FAQ in Chatbot settings.
Upload PDFs and schedules in Content so RAG can answer from them.

Test it

The widget on this demo site is already live (bottom-right). After adding the embed code to your site, reload the page and look for the chat launcher.

Check API health