Check and Install the Site Search Schema - check_schema, apply_schema

Is my index ready for site search, and how to make it ready

Check and install the schema

Two API calls answer "is my index ready for site search?" and fix it when it is not. Use them before you push data or plug in a package, or after you changed the schema yourself.

check_schema reads your index Ready Nothing to do. The schema differs Run apply_schema; force=1 when it holds documents. Not in a region with site search Create a new index in one of those regions. check_schema reads your index Ready Nothing to do. The schema differs Run apply_schema; force=1 when it holds documents. Not in a site search region Create a new index there.

The two calls

Both go to https://opensolr.com and take your email, your API key and the name of the index.

check_schema
Compares the live schema of the index with the site search schema, field by field, dynamic field by dynamic field and type by type, and checks that the index is in a region with site search. It answers what the index can do now (push data, search by meaning, PDF pages, search by words), what is missing or different, and what to do. It changes nothing.
apply_schema
Installs the site search schema on an index in a region with site search, then checks it again. It replaces the configuration of the index, so on an index that already holds documents it asks for force=1, and those documents have to be sent again.
Outside those regions
An index in another region cannot take this schema: pushing data, the vectors Opensolr makes and the hybrid parser run only in the regions with site search. Create a new index in one of them (Packages and index setup) and send your documents there.
In the packages
The LangChain, LlamaIndex, Haystack, MCP and Laravel Scout packages check each index once on their own and say exactly what it cannot do; each one also offers both calls.
# Is my index ready for site search?
curl "https://opensolr.com/solr_manager/api/check_schema?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=YOUR_INDEX"

# Install the schema (add -d force=1 when the index already holds documents)
curl -X POST https://opensolr.com/solr_manager/api/apply_schema \
  -d email=YOUR_EMAIL -d api_key=YOUR_API_KEY -d core_name=YOUR_INDEX

Schema reference pages

Back to Enterprise Site Search