Experimental

The /experimental-features route allows you to manage some of Meilisearch’s experimental features.

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,
  "chatCompletions": false,
  "multimodal": false
}

Name	Type	Description
metrics	Boolean	true if feature is active, false otherwise
logsRoute	Boolean	true if feature is active, false otherwise
containsFilter	Boolean	true if feature is active, false otherwise
editDocumentsByFunction	Boolean	true if feature is active, false otherwise
network	Boolean	true if feature is active, false otherwise
chatCompletions	Boolean	true if feature is active, false otherwise
multimodal	Boolean	true 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

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

Response: 200 Ok

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

Configure experimental features

PATCH

/experimental-features

Activate or deactivate experimental features.

cURL

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,
  "chatCompletions": false,
  "multimodal": false
}