Skip to main content
POST
Create Iframe Widget

Request

string
required
The API key ID to link this widget to. The widget uses this key’s credits, Brand Soul, and allowed origins.
string
Display name for the widget. Default: "My Widget".
object
Visual customization: primaryColor, position (bottom-right | bottom-left), borderRadius, fontFamily, custom CSS overrides.
object
Behavioral settings: welcomeMessage, placeholder, maxPromptLength, enableFileUpload, enableVoice, strictAbuse (enables rate-limiting heuristics).
object
Security settings: requireTurnstile (bot protection), allowedOrigins (domain allowlist override).

Response

string
The widget config UUID. Use this as the configId in the embed script.
string
Widget display name.
string
"active" or "disabled".
string
Ready-to-use HTML <script> tag for embedding on your site.

Authentication

Requires a dashboard session.

Example

curl