Help & getting started

What SearchOS is, how it works, and how to onboard an app in about five minutes.

What is SearchOS?

SearchOS is the fleet's AI-native discovery platform. Apps onboard once and inherit a complete search experience — search, filters, facets, ranking, semantic/vector/hybrid retrieval, AI discovery and a command palette — with no custom search code. It's a control plane(this Studio, where you configure & publish) plus an embedded runtime that runs inside each app against its own data, so apps keep searching even if SearchOS is offline.

Quick start

1 Onboard an app

Paste a Prisma/OpenAPI/GraphQL schema — SearchOS discovers entities, relationships and permissions and generates the whole experience.

Onboard

2 Publish a bundle

Review the generated profile and publish. The compiler signs a versioned bundle.

Bundles

3 Watch runtimes sync

Each app's runtime syncs, verifies and swaps the bundle. See status, versions and health.

Runtime health

4 Try search

Explore results, ranking and the permission pre-filter live in the Playground.

Playground

Key concepts

Organization → Application: Orgs are the top customer level; apps onboard under an org. Each app inherits search with no custom code.
Search profile: The configured search experience for an app — entities, filters, facets, ranking, AI and permissions.
SearchBundle: The compiler turns a profile into an immutable, signed, versioned bundle the runtime downloads and runs.
Embedded runtime: Each app runs @searchos/runtime against its OWN data — SearchOS is never on the query hot path, so search survives an outage.
Providers: Search/vector/graph/cache/AI are swappable behind interfaces — Postgres+pgvector by default, or OpenSearch/Qdrant/… by config.
Pre-filter (permissions): Permissions are enforced during retrieval (deny-by-default, fail-closed), so results/facets/AI never leak what a user can't see.
Certification: Every app gets a pass/warn/fail report + Health and Certification scores from its real state.

Agents & security

SearchOS is AI-first: a team of agents runs the platform (onboarding, discovery, generation, certification, runtime health, security…). Every search is permission-pre-filtered — deny-by-default, fail-closed.