Simple text search
Fast text-based product search matching the query against product names, brands, and
descriptions in the store’s catalog. Returns a ranked list of matches with a relevance
score and a human-readable matchReason.
Auth: accepts both publishable (tybrite_pk_*) and secret (tybrite_sk_*) API keys, so
it is safe to call directly from client-side storefront code — no customer session required.
When to use: use this GET endpoint for fast type-ahead and keyword search where exact
term matching is enough. For natural-language intent (“wireless headphones with noise
cancellation”), use the semantic POST /v1/search (semanticSearch) instead, which scores
by meaning rather than literal terms.
Marketplace: when called with a marketplace operator key, searches products across all
merchants in the marketplace; pass ?store_id=<merchant> to narrow results to a single
merchant.
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: write operations, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Read-only access (GET requests only, plus POST semantic search)
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - All write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Query Parameters
Marketplace operator key only. Narrow the marketplace search to a single merchant's products. Ignored when using a single-store key.
Search query (alternative to 'query' parameter)
Search query (alternative to 'q' parameter)
Maximum number of results to return
1 <= x <= 100
