Deployment & API
Publish your agent with the web widget, use scoped API keys, and connect custom frontends with REST, React, and webhook patterns.
Deployment Overview
The deployment workflow starts in Dashboard > Embed & SDK. Choose an agent, select an API key, copy the integration code, and test the preview before shipping it to production.
API Keys
API key management lives in Tenant Admin > API Keys. Keys can be unrestricted across agents or scoped to one agent.
- ●Copy the full key when it is created; only the prefix is visible later.
- ●Use agent-scoped keys for production embeds whenever possible.
- ●Revoke unused keys immediately if a site, vendor, or environment is retired.
Web Widget
The Web Widget tab generates a script snippet for your selected agent and key. Paste it before the closing </body> tag or into your website builder's custom code area.
- Select the production agent.
- Select the API key created for that website.
- Copy the widget snippet.
- Test on staging before adding it to the live site.
SDK & REST API
The Embed & SDK page also provides JavaScript, REST API, and React examples for custom applications. Use the REST API when you need full control over the user interface or when a backend service sends messages on behalf of a customer.
JavaScript
Fetch-based client example for browser or Node runtimes.
REST API
cURL example for direct proxy chat requests.
React
Component example for React app integration.
Live Preview
The preview panel connects to the selected agent and key. Use it to test greetings, response quality, feedback buttons, and streaming behavior before the widget goes live.
Webhooks
Webhook examples show the shape of events such as message creation, session start/end, and feedback submission. Point webhooks at an endpoint you control, validate the payload, and store only the events your workflow needs.
For production, create separate keys and webhook endpoints for staging and live traffic so testing cannot affect customer systems.