The /experimental-features route allows you to activate or deactivate some of Meilisearch’s experimental features.

This route is synchronous. This means that no task object will be returned, and any activated or deactivated features will be made available or unavailable immediately.

The experimental API route is not compatible with all experimental features. Consult the experimental feature overview for a compatibility list.

​
Experimental features object

{
  "metrics": false,
  "logsRoute": true,
  "containsFilter": false,
  "editDocumentsByFunction": false,
  "network": false
}
NameTypeDescription
metricsBooleantrue if feature is active, false otherwise
logsRouteBooleantrue if feature is active, false otherwise
containsFilterBooleantrue if feature is active, false otherwise
editDocumentsByFunctionBooleantrue if feature is active, false otherwise
networkBooleantrue if feature is active, false otherwise

​
Get all experimental features

GET
/experimental-features

Get a list of all experimental features that can be activated via the /experimental-features route and whether or not they are currently activated.

​
Example

curl \
  -X GET 'MEILISEARCH_URL/experimental-features/'

​
Response: 200 Ok

{
  "metrics": false,
  "logsRoute": true,
  "containsFilter": false,
  "editDocumentsByFunction": false,
  "network": false
}

​
Configure experimental features

PATCH
/experimental-features

Activate or deactivate experimental features.

curl \
  -X PATCH 'MEILISEARCH_URL/experimental-features/' \
  -H 'Content-Type: application/json'  \
  --data-binary '{
    "metrics": true
  }'

Setting a field to null leaves its value unchanged.

​
Body

{<featureName>: <Boolean>}

​
Response: 200 Ok

{
  "metrics": false,
  "logsRoute": true,
  "containsFilter": false,
  "editDocumentsByFunction": false,
  "network": false
}

Was this page helpful?