Skip to main content
POST
Create Custom Component

Headers

string
required
Your API key for authentication.

Body

string
required
Widget identifier UUID to associate with the custom component.
string
required
Pathway UUID to associate with the custom component.
string
required
Pathway node ID to display the custom component on.
string
required
Widget width dimension (e.g., “100%”, “500px”).
string
required
Widget height dimension (e.g., “300px”, “100%”).
string[]
required
Array of available agent variable names to pass into the custom component iframe URL as query params.
string
required
URL for the iframe source.

Response

number
HTTP status code (200 for success).
object
  • id (string): Custom component UUID
  • org_id (string): Organization UUID
  • widget_id (string): Widget identifier UUID
  • pathway_id (string): Associated pathway UUID
  • pathway_node (string): Pathway node ID to display the custom component on
  • width (string): Widget width dimension
  • height (string): Widget height dimension
  • variables (string[]): Array of variable names to pass into the custom component iframe URL as query params
  • iframe_url (string): URL for the iframe source
  • created_at (string): ISO timestamp
  • updated_at (string): ISO timestamp
null
Always null on successful response.

Docs for agents: llms.txt