Get typo tolerance configuration

GET /indexes/{indexUid}/settings/typo-tolerance
Api key

Get the typo tolerance configuration of an index.

Path parameters

  • indexUid string Required

    Index Unique Identifier

Responses

  • • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • enabled boolean

      Enable the typo tolerance feature.

      Default value is true.

    • disableOnAttributes array[string]

      Disable the typo tolerance feature on the specified attributes.

      Default value is [] (empty).

    • disableOnWords array[string]

      Disable the typo tolerance feature for a set of query terms given for a search query.

      Default value is [] (empty).

    • minWordSizeForTypos object
      Hide minWordSizeForTypos attributes Show minWordSizeForTypos attributes
      • oneTypo integer

        Customize the minimum size for a word to tolerate 1 typo.

        Default value is 5.

      • twoTypos integer

        Customize the minimum size for a word to tolerate 2 typos.

        Default value is 9.
  • • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • • 404

    Not Found

GET /indexes/{indexUid}/settings/typo-tolerance 
curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies/settings/typo-tolerance \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "enabled": true,
  "disableOnAttributes": [],
  "disableOnWords": [],
  "minWordSizeForTypos": {
    "oneTypo": 5,
    "twoTypos": 9
  }
}
Response examples (401) 
{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}