Integration
How do API services work with a website widget?
Your API services work with a website widget by embedding a Chatref-powered chat directly on your docs or dashboard. The widget uses AI agents trained on your API reference to answer integration questions, while custom actions let you trigger API calls inside the conversation - turning support chats into self-serve account tasks.
Drop the widget onto your API product
Add the Chatref website widget to your documentation site, developer portal, or app dashboard with a single snippet. No code changes to your API - the widget sits on top, origin-allowlisted for security, and instantly becomes the first line of help for your users. It looks native, matches your brand colors, and runs across desktop and mobile. The widget loads in a few lines of HTML, and your team is live in minutes.
Resolve integration questions automatically with AI agents
Train a Chatref AI agent on your API reference, tutorials, and changelog. Once trained, the agent answers authentication questions, endpoint parameters, error codes, and rate limits - grounded only in your own content. No hallucinations, no generic web answers. Your support queue shrinks because the agent resolves the same integration questions that would otherwise hit your inbox, 24/7.
Trigger API operations from the chat with custom actions
Custom actions turn the website widget into a control surface for your service. Configure the agent to collect required details (like an API key or account ID) and call your own endpoints - renew a token, check usage, update a webhook URL - all inside the same chat thread. That means customers self-serve account tasks without leaving the widget, and your team receives the full context if a human ever needs to step in.
How Chatref keeps support lean for API services
- One snippet, all features: The widget ships with unlimited AI agents, custom actions, and a shared inbox - no feature gating or per-agent fees.
- No per-seat cost: Pay-as-you-go prepaid credits. Top up when you need more responses, pay nothing when idle.
- Answers from your own docs: Grounded in your API reference, so customers always get the right next step.
- Human handoff with full context: When a case needs a developer, your team sees the entire conversation and takes over seamlessly.
Every new account starts with $50 in free credit, no credit card required.
FAQ
API services for website widget
A website widget makes your API docs interactive. Instead of a static search box, your users ask natural-language questions and get instant, accurate answers pulled directly from your reference, guides, and examples. Custom actions allow the widget to call your API endpoints for real-time tasks, so customers can test endpoints, retrieve keys, or view plan details without switching tabs. The result is a faster integration flow and fewer support tickets.
Integrating a website widget with API services
Integration happens in three steps: (1) Add the Chatref snippet to your documentation site or dashboard. (2) Upload your API reference, guides, and changelog so the AI agent learns your service. (3) Configure custom actions to call your endpoints when the chat needs to perform account-level operations (e.g., create a key, check rate-limit status). The widget runs entirely on the frontend, connecting to your API only through the secure custom action routes you define.
Using a website widget for customer support
Embed the widget on your public docs and in-app dashboard. It handles the most common API questions - authentication, parameters, error handling - from your own documentation, day and night. For issues that need a human, the shared inbox lets your team jump in and continue the conversation with full context. Custom actions handle account tasks without involving support staff. The widget turns your website into a self-serve support channel that scales with your user base, not your headcount.
Put this into practice
Chatref answers your customers from your own content, day and night. Add it to your site and go live in minutes – free to start.