Skip to main content
Searching with Omneo Discovery is a two-step flow:
1

Mint a search token

Your backend calls the Omneo API with your Omneo API token and receives a short-lived search token scoped to the indexes you asked for.
2

Query the Discovery host

Your application sends the search request straight to the Discovery host, using the search token as a bearer token.
Search traffic goes directly from the client to Discovery. It does not pass through the Omneo API, which is what keeps typeahead interfaces fast.

Base URLs

All requests are HTTPS only. The Discovery host serves search requests and a health check. Everything else, including any change to what an index contains, goes through the Omneo API.
Your Omneo API token is a long-lived credential. Mint search tokens on a server you control and hand only the search token to a browser or mobile app. See Minting search tokens.

Quick example

Mint a token:
Search with it:

Health check

GET https://discovery.[tenant].getomneo.com/health needs no authentication and returns a status body. Use it for connectivity checks and uptime monitoring.

Getting Discovery enabled

Discovery is provisioned per tenant and is not available by default. Contact your Omneo account manager to have it deployed, to have your indexes populated, and to request a custom attribute mapping if the default fields do not cover your use case.

Next steps

Minting search tokens

Get a token, scope it to an index, and cache it safely.

Running a search

Query parameters, filter syntax, pagination, and facets.

Discovery indexes

The standard profiles and products indexes and their attributes.

Schools index

Search the optional schools reference dataset.