Settings

The /settings route allows you to customize search settings for the given index. You can either modify all of an index's settings at once using the update settings endpoint, or modify each one individually using the child routes.

For a conceptual overview of index settings, refer to our indexes guide.

By default, the settings object looks like this. All fields are modifiable.

{
  "displayedAttributes": [
    "*"
  ],
  "searchableAttributes": [
    "*"
  ],
  "filterableAttributes": [],
  "sortableAttributes": [],
  "rankingRules":
  [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness"
  ],
  "stopWords": [],
  "synonyms": {},
  "distinctAttribute": null,
  "typoTolerance": {
    "enabled": true,
    "minWordSizeForTypos": {
      "oneTypo": 5,
      "twoTypos": 9
    },
    "disableOnWords": [],
    "disableOnAttributes": []
  },
  "faceting": {
    "maxValuesPerFacet": 100
  },
  "pagination": {
    "maxTotalHits": 1000
  }
}

This route allows you to retrieve, configure, or reset all of an index's settings at once.

Get the settings of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings'

{
  "displayedAttributes": [
    "*"
  ],
  "searchableAttributes": [
    "*"
  ],
  "filterableAttributes": [],
  "sortableAttributes": [],
  "rankingRules":
  [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness"
  ],
  "stopWords": [],
  "synonyms": {},
  "distinctAttribute": null,
  "typoTolerance": {
    "enabled": true,
    "minWordSizeForTypos": {
      "oneTypo": 5,
      "twoTypos": 9
    },
    "disableOnWords": [],
    "disableOnAttributes": []
  },
  "faceting": {
    "maxValuesPerFacet": 100
  },
  "pagination": {
    "maxTotalHits": 1000
  }
}

Update the settings of an index.

Passing null to an index setting will reset it to its default value.

Updates in the settings route are partial. This means that any parameters not provided in the body will be left unchanged.

If the provided index does not exist, it will be created.

curl \
  -X PATCH 'http://localhost:7700/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "rankingRules": [
      "words",
      "typo",
      "proximity",
      "attribute",
      "sort",
      "exactness",
      "release_date:desc",
      "rank:desc"
    ],
    "distinctAttribute": "movie_id",
    "searchableAttributes": [
      "title",
      "overview",
      "genres"
    ],
    "displayedAttributes": [
      "title",
      "overview",
      "genres",
      "release_date"
    ],
    "stopWords": [
      "the",
      "a",
      "an"
    ],
    "sortableAttributes": [
      "title",
      "release_date"
    ],
    "synonyms": {
      "wolverine": [
        "xmen",
        "logan"
    ],
      "logan": ["wolverine"]
    },
    "typoTolerance": {
      "minWordSizeForTypos": {
        "oneTypo": 8,
        "twoTypos": 10
      },
      "disableOnAttributes": ["title"]
    },
    "pagination": {
      "maxTotalHits": 5000
    },
    "faceting": {
      "maxValuesPerFacet": 200
    }
  }'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset all the settings of an index to their default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

The attributes added to the displayedAttributes list appear in search results. displayedAttributes only affects the search endpoints. It has no impact on the GET documents endpoint.

By default, the displayedAttributes array is equal to all fields in your dataset. This behavior is represented by the value ["*"].

To learn more about displayed attributes, refer to our dedicated guide.

Get the displayed attributes of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/displayed-attributes'

[
  "title",
  "overview",
  "genres",
  "release_date.year"
]

Update the displayed attributes of an index.

[<String>, <String>, …]

An array of strings. Each string should be an attribute that exists in the selected index.

If an attribute contains an object, you can use dot notation to specify one or more of its keys, for example, "displayedAttributes": ["release_date.year"].

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "title",
    "overview",
    "genres",
    "release_date"
  ]'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the displayed attributes of the index to the default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/displayed-attributes'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

The distinct attribute is a field whose value will always be unique in the returned documents.

To learn more about the distinct attribute, refer to our dedicated guide.

Get the distinct attribute of an index.

curl \
  -X GET 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'

"skuid"

Update the distinct attribute field of an index.

<String>

A string. The string should be an attribute that exists in the selected index.

If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting, for example, "distinctAttribute": "product.skuid".

To learn more about the distinct attribute, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
  -H 'Content-Type: application/json' \
  --data-binary '"skuid"'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the distinct attribute of an index to its default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

With Meilisearch, you can create faceted search interfaces. This setting allows you to define the maximum number of values returned by the facets search parameter.

To learn more about faceting, refer to our dedicated guide.

Get the faceting settings of an index.

curl \
  -X GET 'http://localhost:7700/indexes/books/settings/faceting'

{
  "maxValuesPerFacet": 100
}

Partially update the faceting settings for an index. Any parameters not provided in the body will be left unchanged.

{maxValuesPerFacet: <Integer>}

For example, suppose a query's search results contain a total of three values for a colors facet: blue, green, and red. If you set maxValuesPerFacet to 2, Meilisearch will only return blue and green in the response body's facetDistribution object.

curl \
  -X PATCH 'http://localhost:7700/indexes/books/settings/faceting' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "maxValuesPerFacet": 2
  }'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

You can use the returned taskUid to get more details on the status of the task.

Reset an index's faceting settings to their default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/books/settings/faceting'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

You can use the returned taskUid to get more details on the status of the task.

Attributes in the filterableAttributes list can be used as filters or facets.

To learn more about filterable attributes, refer to our dedicated guide.

Get the filterable attributes for an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/filterable-attributes'

[
  "genres",
  "director",
  "release_date.year"
]

Update an index's filterable attributes list.

[<String>, <String>, …]

An array of strings containing the attributes that can be used as filters at query time.

If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting: "filterableAttributes": ["release_date.year"].

To learn more about filterable attributes, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "genres",
    "director"
  ]'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset an index's filterable attributes list back to its default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/filterable-attributes'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

To protect your database from malicious scraping, Meilisearch has a default limit of 1000 results per search. This setting allows you to configure the maximum number of results returned per search.

maxTotalHits takes priority over search parameters such as limit, offset, hitsPerPage, and page.

For example, if you set maxTotalHits to 100, you will not be able to access search results beyond 100 no matter the value configured for offset.

To learn more about paginating search results with Meilisearch, refer to our dedicated guide.

Get the pagination settings of an index.

curl \
  -X GET 'http://localhost:7700/indexes/books/settings/pagination'

{
  "maxTotalHits": 1000
}

Partially update the pagination settings for an index.

{maxTotalHits: <Integer>}

curl \
  -X PATCH 'http://localhost:7700/indexes/books/settings/pagination' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "maxTotalHits": 100
  }'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

You can use the returned taskUid to get more details on the status of the task.

Reset an index's pagination settings to their default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/books/settings/pagination'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

You can use the returned taskUid to get more details on the status of the task.

Ranking rules are built-in rules that rank search results according to certain criteria. They are applied in the same order in which they appear in the rankingRules array.

To learn more about ranking rules, refer to our dedicated guide.

[
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness"
]

Get the ranking rules of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/ranking-rules'

[
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:desc"
]

Update the ranking rules of an index.

[<String>, <String>, …]

An array that contains ranking rules in order of importance.

To create a custom ranking rule, give an attribute followed by a colon (:) and either asc for ascending order or desc for descending order.

• To apply an ascending sort (results sorted by increasing value): attribute_name:asc
• To apply a descending sort (results sorted by decreasing value): attribute_name:desc

To learn more about ranking rules, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
  ]'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the ranking rules of an index to their default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/ranking-rules'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

The values associated with attributes in the searchableAttributes list are searched for matching query words. The order of the list also determines the attribute ranking order.

By default, the searchableAttributes array is equal to all fields in your dataset. This behavior is represented by the value ["*"].

To learn more about searchable attributes, refer to our dedicated guide.

Get the searchable attributes of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/searchable-attributes'

[
  "title",
  "overview",
  "genres",
  "release_date.year"
]

Update the searchable attributes of an index.

[<String>, <String>, …]

An array of strings. Each string should be an attribute that exists in the selected index. The array should be given in order of importance: from the most important attribute to the least important attribute.

If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting: "searchableAttributes": ["release_date.year"].

To learn more about searchable attributes, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "title",
    "overview",
    "genres"
  ]'

In this example, a document with a match in title will be more relevant than another document with a match in overview.

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the searchable attributes of the index to the default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/searchable-attributes'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Attributes that can be used when sorting search results using the sort search parameter.

To learn more about sortable attributes, refer to our dedicated guide.

Get the sortable attributes of an index.

curl \
  -X GET 'http://localhost:7700/indexes/books/settings/sortable-attributes'

[
  "price", 
  "author.surname"
]

Update an index's sortable attributes list.

You can read more about sorting at query time on our dedicated guide.

[<String>, <String>, …]

An array of strings. Each string should be an attribute that exists in the selected index.

If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting: "sortableAttributes": ["author.surname"].

To learn more about sortable attributes, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "price",
    "author"
  ]'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset an index's sortable attributes list back to its default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/books/settings/sortable-attributes'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Words added to the stopWords list are ignored in future search queries.

Get the stop words list of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/stop-words'

[
  "of",
  "the",
  "to"
]

Update the list of stop words of an index.

[<String>, <String>, …]

An array of strings. Each string should be a single word.

If a list of stop words already exists, it will be overwritten (replaced).

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "the",
    "of",
    "to"
  ]'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the list of stop words of an index to its default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/stop-words'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

The synonyms object contains words and their respective synonyms. A synonym in Meilisearch is considered equal to its associated word for the purposes of calculating search results.

To learn more about synonyms, refer to our dedicated guide.

Get the list of synonyms of an index.

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/synonyms'

{
  "wolverine": [
    "xmen",
    "logan"
  ],
  "logan": [
    "wolverine",
    "xmen"
  ],
  "wow": [
    "world of warcraft"
  ]
}

Update the list of synonyms of an index. Synonyms are normalized.

{
  <String>: [<String>, <String>, …],
  …
}

An object that contains all synonyms and their associated words. Add the associated words in an array to set a synonym for a word.

To learn more about synonyms, refer to our dedicated guide.

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "wolverine": [
      "xmen",
      "logan"
    ],
    "logan": [
      "wolverine",
      "xmen"
    ],
    "wow": ["world of warcraft"]
  }'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset the list of synonyms of an index to its default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/synonyms'

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Typo tolerance helps users find relevant results even when their search queries contain spelling mistakes or typos. This setting allows you to configure the minimum word size for typos and disable typo tolerance for specific words or attributes.

To learn more about typo tolerance, refer to our dedicated guide.

Get the typo tolerance settings of an index.

curl \
  -X GET 'http://localhost:7700/indexes/books/settings/typo-tolerance'

{
  "enabled": true,
  "minWordSizeForTypos": {
    "oneTypo": 5,
    "twoTypos": 9
  },
  "disableOnWords": [],
  "disableOnAttributes": []
}

Partially update the typo tolerance settings for an index.

{
  "enabled": <Boolean>,
  "minWordSizeForTypos": {
    "oneTypo": <Integer>,
    "twoTypos": <Integer>
  },
  "disableOnWords": [<String>, <String>, …],
  "disableOnAttributes": [<String>, <String>, …]
}

curl \
  -X PATCH 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "minWordSizeForTypos": {
      "oneTypo": 4,
      "twoTypos": 10
    },
    "disableOnAttributes": ["title"]
  }'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

You can use the returned taskUid to get more details on the status of the task.

Reset an index's typo tolerance settings to their default value.

curl \
  -X DELETE 'http://localhost:7700/indexes/books/settings/typo-tolerance'

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

You can use the returned taskUid to get more details on the status of the task.