ScalixScalix Docs

Search API

Original-source curated search index

REST API endpoints for Search. 5 operations.

Run a search

plaintext
GET /v1/search

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

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
qquerystringNoSearch query

Responses

StatusDescription
200Search results
401Missing or invalid API key
500Internal error

operationId: searchIndex

Run a search ingest

plaintext
POST /v1/search/ingest/run

Triggers an ingest run that crawls and indexes registered sources.

Auth: Bearer API key

Responses

StatusDescription
200Ingest run triggered
401Missing or invalid API key
500Internal error

operationId: runSearchIngest

List search sources

plaintext
GET /v1/search/sources

Returns the curated sources registered in the search index.

Auth: Bearer API key

Responses

StatusDescription
200Curated source list
401Missing or invalid API key
500Internal error

operationId: listSearchSources

Upsert a search source

plaintext
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

StatusDescription
200Source upserted
401Missing or invalid API key
500Internal error

operationId: upsertSearchSource

Get search stats

plaintext
GET /v1/search/stats

Returns statistics about the search index.

Auth: Bearer API key

Responses

StatusDescription
200Index stats
401Missing or invalid API key
500Internal error

operationId: getSearchStats