Three steps from zero to live AI search on your site. Or follow the Getting Started guide for a full walkthrough with screenshots.

Prerequisites

A SurfableAI account (sign up here)
Your website URL
A terminal or HTTP client (curl, Postman, Insomnia)

Steps

1. Sign up and index your site

Create an account at surfable.ai. Enter your website URL on signup and Surfable automatically crawls and indexes your content in the background. You can monitor crawl progress on the Dashboard → Index tab.

2. Generate an API key

Go to Dashboard → API Keys → Create Key. Use this key in the Authorization header for all API requests. Keep it server-side — never expose it in client-side JavaScript.

3. Send your first query

curl -X POST https://api.surfable.ai/search \
  -H "Authorization: Bearer sk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I get started?"}'

You'll get back a ranked list of semantically matched content chunks from your indexed site.

4. Widget Routing (Optional)

When using the Surfable HTML widget or React components (@surfable/widget), the originating_url of the current page is automatically included in every API request. This enables Widget Routing — you can configure URL-based rules in the Surfable Dashboard to serve different AI modes (Search, Chat, Agent) or system prompts depending on the page the user is viewing.

To opt out of this behavior, set the routingEnabled prop to false on the React components.

Next Steps

Integrations — embed the widget or use the React component
API Reference — full endpoint listing
CLI — manage ingest and search from your terminal