Documentation

Integration Guide

Get Regor running on your store in under 5 minutes.

1. Get your API keys

Sign up at /signup to receive your publishable key (pk_live_) and secret key (sk_live_). The publishable key is safe for browser use. The secret key is for server-to-server requests only.

2. Push your catalog

Send your product catalog via POST /v1/catalog/upsert with your secret key. Required fields: id, sku, name, category, price, available, product_url. You can also upload a CSV via POST /v1/catalog/upload.

curl -X POST https://api.regor.ai/v1/catalog/upsert \
  -H "X-API-Key: YOUR_SK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "products": [{
      "id": "SKU-001",
      "sku": "SKU-001",
      "name": "Example Product",
      "category": "Category",
      "price": 29.99,
      "available": true,
      "product_url": "https://yourstore.com/products/example"
    }]
  }'

3. Install the tracking snippet

Add the Regor snippet before </body>. Set data-mode="collect" to shadow your existing search, or "replace" to let Regor serve results directly.

<script
  src="https://api.regor.ai/static/regor.js"
  data-key="YOUR_PK_KEY"
  data-mode="collect"
></script>

4. Verify events

Open your site, perform a search, and check the Network tab for POST requests to /v1/events. Within 15 minutes of events flowing, AI agents begin analyzing your search quality.

API Reference

POST /v1/catalog/upsertPush products (sk_live_ key)
POST /v1/catalog/uploadUpload CSV catalog (sk_live_ key)
GET /v1/catalog/statsCheck index status (pk_live_ key)
GET /v1/searchSearch products (pk_live_ key)
POST /v1/eventsTrack events (auto via snippet)
POST /v1/billing/checkoutStart subscription (JWT auth)
GET /v1/billing/statusCheck billing status (JWT auth)