API Reference
Everything you need to integrate Skawr search into your application. Base URL: https://api.skawr.com
Getting Started
Sign up at skawr.com/saas/import — paste your store URL or upload a CSV to index your products. You'll get an API key immediately.
Authentication
All API requests require an API key passed via the X-API-Key header. Keys use a prefix.suffix format — the 8-char prefix is safe for frontend (search-only), the full key grants write access.
Search
Search your indexed products with hybrid BM25 + semantic matching.
{
"query": "iPhone 15 Pro",
"per_page": 10,
"filters": {
"brand": "Apple"
}
}{
"results": [
{
"id": "prod_abc123",
"title": "iPhone 15 Pro Max 256GB",
"price": 4299,
"currency": "SAR",
"image_url": "https://...",
"score": 0.97
}
],
"total": 42,
"query_time_ms": 23
}Autocomplete
Get instant search suggestions as users type.
GET /api/v1/autocomplete?q=ipho&limit=5
{
"suggestions": [
"iPhone 15 Pro",
"iPhone 15 Pro Max",
"iPhone case",
"iPhone charger"
]
}Upload Documents
Add or update documents in your search index.
{
"documents": [
{
"id": "prod_001",
"title": "Samsung Galaxy S24 Ultra",
"price": 4699,
"currency": "SAR",
"brand": "Samsung",
"image_url": "https://...",
"categories": ["Electronics", "Phones"]
}
]
}{
"indexed": 1,
"errors": []
}Bulk Upload
Upload thousands of products in a single request. Supports JSON array or CSV.
// JSON array of products (up to 10,000 per request)
[
{ "id": "1", "title": "Product A", "price": 99 },
{ "id": "2", "title": "Product B", "price": 149 }
]{
"indexed": 2,
"total_time_ms": 1230
}Usage & Limits
Check your current usage against your plan limits.
GET /api/v1/saas/usage
{
"plan": "Growth",
"products_indexed": 12847,
"products_limit": 50000,
"searches_this_month": 23419,
"searches_limit": 500000
}SDKs & Integrations
We provide official SDKs for quick integration: • JavaScript (npm): @skawr/sdk — full backend access • JavaScript (frontend): @skawr/search — search-only, uses prefix key • Flutter/Dart: skawr_sdk • PHP: skawr/sdk Native integrations: Salla (zero-code app), Shopify (theme extension). For platforms without an SDK, use the REST API directly with any HTTP client.