Experimental

    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.

    DANGER

    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,
      "scoreDetails": false,
      "vectorSearch": false,
      "exportPuffinReports": false
    }
    
    NameTypeDescription
    metricsBooleantrue if feature is active, false otherwise
    scoreDetailsBooleantrue if feature is active, false otherwise
    vectorSearchBooleantrue if feature is active, false otherwise
    exportPuffinReportsBooleantrue 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 'http://localhost:7700/experimental-features/'

    Response: 200 Ok

    {
      "metrics": false,
      "scoreDetails": false,
      "vectorSearch": false,
      "exportPuffinReports": false
    }
    

    Configure experimental features

    PATCH/experimental-features

    Activate or deactivate experimental features.

    curl \
      -X PATCH 'http://localhost:7700/experimental-features/' \
      -H 'Content-Type: application/json'  \
      --data-binary '{
        "scoreDetails": true
      }'

    Setting a field to null leaves its value unchanged.

    Body

    {<featureName>: <Boolean>}
    

    Response: 200 Ok

    {
      "metrics": false,
      "scoreDetails": true,
      "vectorSearch": false,
      "exportPuffinReports": false
    }