Index settings and Search API parameters

Configurable options for the Search API and index settings, grouped by when and how they take effect

Scope

Parameters have scopes, which determine when they take effect.

Settings

These are index settings. They configure the index and apply to all subsequent searches. You can set these settings with the Set settings method.

For an overview, see Index settings.

Search

These are search parameters. They only affect the current request and can be used in these methods:

• Search single index
• Search multiple indices
• Search for facet values
• Browse (some parameters are ignored)
• Add API key (as API key restriction)
• Update API key

For an overview, see Search API parameters.

Settings and search

These parameters can be used both as index settings and search parameters. This lets you set a default value in the index configuration and override if for individual requests.