SystemService class provides health checks and basic metadata about the Tybrite API. These methods are public and do not require authentication apart from getStoreInfo.
Access this service via client.system.
getStoreInfo
Retrieve comprehensive store metadata, configuration, and catalog statistics in a single API call. This endpoint is specifically optimized for initial data synchronizations, AI agent context setting, and dashboard overviews.
The store section includes business context — name, logo_url, description, website, phone, email, and address (any of which may be null) — alongside currencies, timezone, and creation date. The catalog.products block includes a thin sample array (at most 10 items, each { id, name, category, price, image, featured }) — a small sample of products for context; use client.products.listProducts to browse the full catalog.
- Caching: Responses are cached for 5 minutes by default.
- Selective Loading: Use the
sectionsparameter to tailor the response and reduce payload size by up to 80%. - Single-store only: This endpoint describes one store. A marketplace operator key receives
403— useclient.marketplace.getMarketplaceInfofor the marketplace’s own information, orgetMarketplaceInfo({ storeId })for one merchant within it.
The
store section (ID, Name, Timezone, Currencies) is always included regardless of the filtered sections.features block is a flat set of booleans your storefront can use to show/hide capabilities: ai_recommendations, semantic_search, multi_currency, dynamic_pricing, gift_cards, promotions, cms (blog/CMS posts), lookbooks (shoppable lookbooks — separate from cms), messaging, specifications, and collections.
getApiInfo
Retrieve basic information about the API, including the current version and list of available endpoint prefixes.
healthCheck
Verify the operational status of the Tybrite API. The gateway probes all individual services in parallel and returns a per-service status map alongside an overall rollup. Useful for monitoring integrations, connectivity troubleshooting, or building your own status dashboards.
Each service probe has a 3-second timeout. A service that exceeds it returns
{ status: 'error', latency_ms: null }.
Caching:
getStoreInfo responses are cached for 5 minutes (300s). Repeat calls return quickly from cache. Pass cache: false to force a fresh response.Response Codes
getApiInfo (GET /) and healthCheck (GET /v1/health)
These endpoints are unauthenticated — no
401, 403, or 429 is emitted.

