Pular para o conteúdo principal
POST
/
api
/
v1
/
browse
Browse
curl --request POST \
  --url https://api.example.com/api/v1/browse

​
Authentication

All requests must include an API key via the x-api-key header or key query parameter. 
curl -X POST https://alana.shopping/api/v1/browse \
  -H "Content-Type: application/json" \
  -H "x-api-key: ak_your_api_key" \
  -d '{"categoryPath": "roupas/camisetas"}'

​
Rate Limits

LevelLimitWindow
Per API key1,000 requests1 minute
Per API key + IP100 requests1 minute

​
Overview

Browse is designed for category pages — it returns products without a text query. Unlike search, which ranks by semantic similarity, browse ranks by optimization_score (the AI Commerce Score) by default. Boost rules are automatically applied to browse results when active rules exist for the workspace.

​
Request Format

All fields are optional. An empty body {} returns all products sorted by optimization score. 
{
  "categoryPath": "roupas/camisetas",
  "sortBy": "price_asc",
  "page": 0,
  "hitsPerPage": 20
}
FieldTypeDefaultDescription
categoryPathstring or array—Category path to filter by (e.g. "roupas/camisetas" or ["roupas","camisetas"])
sortBystringoptimization_scoreSort order (see Sorting below)
pageinteger00-based page number
hitsPerPageinteger (1–100)20Results per page
facetsstring[]—Facet attributes to compute counts for
facetFiltersarray—Disjunctive facet filters

​
Sorting

ValueDescription
optimization_score (default)AI Commerce Score ranking
price_ascPrice low to high
price_descPrice high to low
newestMost recently added
relevanceSemantic similarity (embed-based)

​
Response Format

Browse returns the same Algolia-compatible response format as Search. 
{
  "hits": [...],
  "nbHits": 142,
  "page": 0,
  "nbPages": 8,
  "hitsPerPage": 20,
  "facets": {
    "brand": {"Nike": 45, "Adidas": 32}
  },
  "processingTimeMs": 18
}
Última modificação em 12 de março de 2026