Reference
Console guide
The console is a Next.js web app that sits on the same enforcement core as the API. It is the fastest way to explore an index, run searches, and read the cost/latency trace.
Signing in#
The console requires a session — every route except /login and /signup is guarded. Visiting any protected path while signed out redirects to /login?next=… so you return to where you were headed.
- Password — email + password sign-in.
- Email code — a one-time 6-digit code.
- Magic link — a sign-in link by email.
- Google — available once OAuth credentials are configured.
Sessions map to principals
Principal shape as an API token, so the scope clamp and ACL filter behave identically whether you use the UI or the REST API.Workspace: namespace & scope#
The console is organized around a workspace URL of the form /<namespace>/<scope>. The active namespace and scope are persisted, and the root path redirects you into your last workspace. The scope you pick drives the same effective-scope resolution described in the Security model.
Overview#
The workspace overview surfaces the catalog KPIs from GET /v1/catalog/stats — per-plane vector counts and health, catalog row totals, and query counters — so you can see the shape of the index at a glance.
Search playground#
The search page is a live playground for POST /v1/search. Enter a natural-language query, choose planes and options, and inspect results with their Locators. The trace panel breaks down each pipeline stage’s latency and compute cost, and the ACL banner reports how many results were hidden from you.
Unit browser#
The browser lists Units in the active scope (backed by GET /v1/units), ACL- filtered to what you are allowed to see, with lazy pagination. Open a Unit to view its full row and Locator.