SightScout Docs

Ship text, semantic, and visual search in minutes. Use this quickstart to index data, call the APIs, and embed the live search widget.

Overview

Unified search platform: text + semantic + visual.
REST APIs, ready for curl, JS/TS, Python.
Widget demo (hero search) uses the same APIs.

Key endpoints

POST /api/search/text
POST /api/search/semantic
POST /api/search/visual

Resources

1. Index your data

Create records with text, metadata, and optional images. For the demo we load public/data/products.json.

curl -s https://sightscout.net/api/search/index \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1,
    "title": "Aurora Sneakers",
    "description": "Lightweight running shoes with breathable mesh",
    "keywords": ["running","sport"],
    "category": "Footwear",
    "image": "/assets_home/images/products/p1.png"
}'

2. Query the APIs

Text search

Semantic search

Visual search

3. Embed the widget

Reuse the hero component logic — tabs for Text/Semantic/Visual, debounced input, Command dropdown, keyboard navigation, highlights, and result badges.

<script src="https://sightscout.net/js/widget.min.js" defer></script>
<script>
  window.SightScoutWidget && window.SightScoutWidget.init({
    selector: '#search',
    mode: 'text',
    endpoint: 'https://sightscout.net/api/search',
    maxResults: 8,
    theme: 'auto'
  });
</script>

Production checklist

Swap local dataset for your index (text + embeddings + visual vectors).
Point APIs to your managed infrastructure.
Set API keys and feature flags in the widget/init scripts.
Monitor usage via your search backend; adjust ranking rules.