RAG White-Label

Query across all your customer data

The same two endpoints called with your provisioning token search every API account's index at once, for a global search bar across your whole platform.

Raw markdown guide for AI
Guide contents

The same two endpoints called with your provisioning token run organisation-wide: the per-customer isolation filter is dropped, so retrieval spans every API account's index plus your organisation-level content in one search.

Example: a marketplace with many sellers offering one global search across the whole platform: each seller's own storefront widget queries with their token, while the marketplace's global search bar queries with the provisioning token.

GET /question behaves the same way: swap the token and one answer is grounded across the whole fleet, citations included.

Add response_format=structured to either endpoint to receive the same opt-in schema used by customer-scoped queries: top-level format, query, markdown, and results; each result contains content, position, rank, score, content_sha, and sources; and each source contains citation, uid, title, url, source_updated_at, and connection. The provisioning token changes the retrieval scope, not the response shape. If response_format is absent or has any value other than structured, each endpoint keeps its existing default response.

Reads only

Writes are refused in this mode. Saving a namespace with a provisioning token answers 403:

{ "error": "The provisioning token is read-only on this endpoint. Save with an api_account query token." }

An organisation-wide memory write would be fleet-visible with no sensible owner, so save with a customer token instead and the note lands in exactly one customer's index.

A provisioning token stops authenticating the moment it stops being eligible: the holder is demoted from admin, or the organisation leaves the white-label plan. It does not degrade into a normal user-scoped credential.