Introduction
Use the current SupportGPT developer surface: hosted widget, iframe, and visitor identification.
The current developer surface for SupportGPT is the hosted embed script and iframe.
There is not a supported public npm SDK or stable public REST API documented today. The app contains authenticated /api/* routes for the dashboard and widget, but those routes are implementation details and can change.
What Developers Can Use Today
- Hosted script:
https://supportgpt.app/embed.min.js. - Widget initialization with
window.supportgpt.init({ chatbotId }). - Visitor identification with
window.supportgpt.identify(...). - Widget controls:
open,close,show, andhide. - Event listeners through
addEventListenerandremoveEventListener. - Direct iframe URL:
https://supportgpt.app/chatbot-iframe/<AGENT_ID>.
Recommended Integration Path
- Create and test an agent in the dashboard.
- Open Deploy -> Embed.
- Copy the chat bubble snippet or Next.js snippet.
- Paste it into your app layout or site template.
- Optionally add identity verification and
identify()for logged-in users. - Test handoff visibility and unread badges in a staging environment.
When To Use The Iframe
Use the iframe when you want a full chat panel inside a known page area. Use the chat bubble when you want a floating support widget across a site.