Get a product dossier
Everything an agent needs to reason about one product: each variant with its live stock and the price a shopper is charged, the promotion that applies to one unit, published specifications (per variant and merged), the review summary, where the store ships and at what base fees, and the store’s return window.
A specification the merchant has not published is absent, never inferred. The exact shipping fee for an
address comes from POST /v1/agent/quote.
Cached at the edge for up to five minutes and purged when the catalogue changes.
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.
Path Parameters
The product.
Query Parameters
Comma-separated top-level keys of data to return, e.g. fields=grand_total,lines.

