Skip to main content
GET
Get Widget by ID

Headers

authorization
string
required
Your API key for authentication.

Path Parameters

id
string
required
UUID of the widget to retrieve.

Response

status
number
HTTP status code (200 for success).
data
object
The widget object containing:
  • id (string): Widget UUID
  • pathway_id (string | null): Associated pathway UUID
  • agent_id (string | null): Associated agent UUID or null
  • agent_prompt (string | null): Agent prompt used instead of pathway
  • allowed_domains (string[]): Array of allowed domains
  • messages_per_minute (number): Rate limit for messages
  • config (object): Widget configuration object
  • created_at (string): ISO timestamp
  • updated_at (string): ISO timestamp
errors
null
Always null on successful response.

Docs for agents: llms.txt