Search API

Search API for the curated Scalix Search index to run ranked queries, manage source registrations, trigger ingest runs, and read index stats.

REST API endpoints for Search. 5 operations.

Run a search

GET /v1/search

Runs a query against the curated Scalix Search index and returns ranked results.

Auth: Bearer API key

Parameters

Responses

operationId: searchIndex

Run a search ingest

POST /v1/search/ingest/run

Triggers an ingest run that crawls and indexes registered sources.

Auth: Bearer API key

Responses

operationId: runSearchIngest

List search sources

GET /v1/search/sources

Returns the curated sources registered in the search index.

Auth: Bearer API key

Responses

operationId: listSearchSources

Upsert a search source

POST /v1/search/sources

Creates or updates a curated source in the search index.

Auth: Bearer API key

Request body

application/json (required) — schema object.

Responses

operationId: upsertSearchSource

Get search stats

GET /v1/search/stats

Returns statistics about the search index.

Auth: Bearer API key

Responses

operationId: getSearchStats