Skip to main content
POST
Create Widget

Headers

authorization
string
required
Your API key for authentication.

Body

pathway_id
string
UUID of the pathway to associate with the widget. Must be defined if agent_prompt is null.
agent_prompt
string
Prompt to use for the widget agent. Must be defined if pathway_id is null.
allowed_domains
string[]
required
Array of domains where the widget can be embedded.
messages_per_minute
number
required
Rate limit for messages (minimum: 0).
config
any
required
Widget configuration object (flexible JSON). Supports timeoutSeconds to configure conversation timeout (default: 86400 seconds / 24 hours).
agent_id
string
Optional UUID of agent to associate with widget.
webhook_url
string
Optional URL to receive post-conversation webhook payloads when conversations end. See Post-Conversation Webhooks for payload details.

Response

status
number
HTTP status code (200 for success).
data
object
The created widget object containing:
  • id (string): Generated widget UUID
  • pathway_id (string): Associated pathway UUID
  • agent_id (string | null): Associated agent UUID or null
  • allowed_domains (string[]): Array of allowed domains
  • messages_per_minute (number): Rate limit for messages
  • config (object): Widget configuration object
  • webhook_url (string | null): Post-conversation webhook URL or null
  • created_at (string): ISO timestamp
  • updated_at (string): ISO timestamp
errors
null
Always null on successful response.

Docs for agents: llms.txt