Skip to main content

Quickstart

1. Ask To-AI to provision the tenant​

Before coding, obtain:

  • tenant organization id;
  • tenant API credential with the least required scopes;
  • enabled catalog/search/media/public-chat features;
  • activated schema and AI profile;
  • webhook integration key id, native shop id, and secret when sending inventory events.

Do not place credentials in browser JavaScript. A tenant-owned backend calls the credentialed APIs.

2. Discover the contract​

Call GET /api/v1/catalog/index-sync/schema?request_id=.... Generate connector validation from the returned required/supported fields, limits, media policy, inventory policy, and active schema configuration.

3. Synchronize schema, then products​

  1. create a schema-sync run;
  2. send ordered schema batches;
  3. complete the run and wait for activated;
  4. send product batches with stable external ids, monotonic updated_at, and idempotency keys;
  5. poll product status and search capabilities until projection/readiness converge.

4. Choose a customer surface​

  • Search bar: call the Search API from your backend.
  • Shopping assistant: call assistant bootstrap, then use the returned Broker endpoints and short-lived token.

5. Keep data current​

Send only changed products. A content change invalidates and refreshes only that product's embedding. Send inventory deltas through the signed v2 webhook instead of rewriting descriptive product content.

6. Run conformance​

Verify idempotent replay, stale update rejection, tenant isolation, semantic readiness, product media, assistant stream, retry behavior, and inventory freshness before launch.