Skip to main content
POST
Create Widget

Headers

string
required
Your API key for authentication.

Body

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

Response

number
HTTP status code (200 for success).
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
null
Always null on successful response.

Docs for agents: llms.txt