Skip to main content
The SDK API reference is split across a few focused pages:

Client methods

collection(), blocks(), search(), suggest(), uploadImage(), searchByImage(), searchContent(), the product card controller, and abort signal patterns.

Filtering

Filter DSL, operators, and filter aliases configured at client init.

Response types and error handling

Shared QueryResult shape, the tagged error model, and retry helpers.

Cache, storage, and signals

Cache API, storage adapters, signal primitives, singleton access, and SDK technical details.

​
Controller lifecycle at a glance

All controllers follow the same pattern with reactive state and three ways to subscribe:
  • state — a ReadonlySignal<QueryState<T>> with { data, error, isFetching }
  • execute() — runs the query, returns Result<T, ClientError>
  • subscribe(callback) — reacts to state changes without importing signals
  • dispose() — cleans up subscriptions and aborts pending requests
See Client methods for the full list.

​
Next steps