Skip to main content

Host Capabilities

Host capabilities let your website or app expose safe actions to the widget.

What This Is For

Use host capabilities when the AI agent should interact with your app interface, such as:

  • Open a product page.
  • Select a plan.
  • Start checkout.
  • Highlight an item.
  • Navigate to account settings.
  • Trigger a support form.

The AI agent can only request actions you declare.

How It Works

Enable Host Actions

  1. Open the integration.
  2. Enable host actions.
  3. Save the integration.
  4. Update your website or app integration to declare available actions.
  5. Test each action from a real widget session.

Declare Only Safe Actions

Declare actions that are safe for the AI agent to request.

For sensitive actions:

  • Ask the user to confirm in your app.
  • Validate all inputs.
  • Keep final authority in your own app or API.
  • Never let the AI agent perform irreversible actions without confirmation.

Example Capability Shape

Your integration should describe pages and actions in a structured way. A simplified example:

{
"pages": [
{
"id": "products",
"title": "Products",
"actions": [
{
"name": "open_product",
"description": "Open a product detail page",
"schema": {
"type": "object",
"properties": {
"product_id": { "type": "string" }
},
"required": ["product_id"]
}
}
]
}
]
}

Use the integration format provided by your widget setup. The important rule is that action names and argument schemas must be explicit.

Verification Checklist

  • Host actions are enabled on the integration.
  • The widget receives declared capabilities.
  • The AI agent can see only declared actions.
  • Your app validates action requests before executing them.
  • Sensitive actions require user confirmation.