Developers • REST API
Build search & assistant experiences with API
FeatSearch provides clean endpoints for product search (image + text) and a catalog-grounded shopping assistant (chat).
Core endpoints
- •POST /v1/search — image + text product search
- •POST /v1/chat — assistant replies grounded in catalog
- •POST /v1/recommend — similar/related items
- •GET /v1/status — health & readiness
Catalog-grounded
The assistant recommends only products from your catalog and follows your constraints (availability, category, budget, etc.).
Authentication
Use an API key per tenant (shop / platform site). Rate limits and usage tracking are supported for multi-tenant deployments.
Versioning
Keep integrations stable with versioned routes (e.g. /v1/*).
Search example
POST /v1/search
Content-Type: application/json
{
"query_text": "white dress with floral pattern",
"query_image_url": "https://.../image.jpg",
"top_k": 8
}{
"results": [
{
"product_id": "p_1029",
"title": "Floral Summer Dress",
"url": "https://shop.com/products/p_1029",
"score": 0.86
}
]
}Assistant example
POST /v1/chat
Content-Type: application/json
{
"message": "I need a sofa for a small living room, easy to clean.",
"constraints": { "budget_max": 400, "category": "sofa" }
}{
"reply": "Got it. Do you prefer fabric or leather? Here are 3 easy-to-clean options from your catalog...",
"recommended_product_ids": ["p_210", "p_334", "p_551"]
}