Configure experimental features

Enable or disable experimental features at runtime.

PATCH /experimental-features

cURL

cURL

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

200

{
  "metrics": true,
  "logsRoute": false,
  "editDocumentsByFunction": false,
  "containsFilter": false,
  "dynamicSearchRules": false,
  "network": false,
  "getTaskDocumentsRoute": false,
  "taskQueueCompactionRoute": false,
  "compositeEmbedders": false,
  "chatCompletions": false,
  "multimodal": false,
  "foreignKeys": false
}

Authorizations

Authorization · string · header · required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Response

200

application/json

Experimental features are returned.

Experimental features that can be toggled at runtime

metrics · boolean | null

Enable the /metrics endpoint for Prometheus metrics

logsRoute · boolean | null

Enable the /logs route for log configuration

editDocumentsByFunction · boolean | null

Enable document editing via JavaScript functions

containsFilter · boolean | null

Enable the CONTAINS filter operator

dynamicSearchRules · boolean | null

Enable dynamic search rules and the /dynamic-search-rules routes

network · boolean | null

Enable network features for distributed search

getTaskDocumentsRoute · boolean | null

Enable the route to get documents from tasks

taskQueueCompactionRoute · boolean | null

Enable the route to compact the task queue database

compositeEmbedders · boolean | null

Enable composite embedders for multi-source embeddings

chatCompletions · boolean | null

Enable chat completion capabilities

multimodal · boolean | null

Enable multimodal search with images and other media

foreignKeys · boolean | null

Enable foreign key support for document hydration