Custom API
Define a controlled REST API action with explicit endpoint, parameters, and request templates.
Custom API lets an agent call a REST endpoint you define. In Configure, provide the endpoint URL and choose GET, POST, PUT, or DELETE. You can add headers, a request-body template for non-GET requests, and typed string, number, or boolean parameters. Use {{parameter}} placeholders in the URL, headers, and body when the request needs information the agent collects during the conversation. The configuration screen includes a browser-side test request for quick feedback.
Treat the endpoint and every header as production credentials. At runtime, required parameters and destination safety checks are enforced, requests have a bounded timeout, redirects are not followed, and returned output is limited. A non-success response is still meaningful evidence for the agent and should be investigated rather than silently treated as a success. The configuration test is not a substitute for validating the deployed runtime path.
Custom API is high risk. Widget chat with action approval enabled asks the visitor to confirm before it runs. Read-only requests may be retry-safe, while mutating requests are not automatically retried. Use a narrowly scoped endpoint, avoid secrets in prompts, and test with a sandbox API before exposing it to visitors.