Configure which attributes appear as filter options in search results. Supports value facets (exact match), range facets (numeric intervals), and hierarchical facets (category trees).
Authentication
All requests must include an API key via the x-api-key header.
Endpoints
FacetConfig Object
facet_type Values
GET /api/v1/facets/config
List all facet configurations for the authenticated workspace.
POST /api/v1/facets/config
Create a new facet configuration.
Returns 201 Created with the new FacetConfig object.
PUT /api/v1/facets/config/
Update an existing facet configuration.
DELETE /api/v1/facets/config/
Delete a facet configuration. Returns 204 No Content.
Using Facets in Search
Once configured, request facet counts in POST /api/v1/search:
Facet counts use disjunctive logic — filtering by brand:Nike still shows all brands in the facets.brand response, allowing users to switch filters without losing context. Última modificação em 12 de março de 2026