Skip to main content
GET
/
indexes
/
{indexUid}
/
settings
/
typo-tolerance
cURL
curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/typo-tolerance'
{}

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'
});

Path Parameters

​
indexUid
string
required

Unique identifier of the index.

Response

Returns the current value of the typoTolerance setting.

Configuration for typo tolerance in search queries.

Typo tolerance allows Meilisearch to match documents even when search terms contain spelling mistakes.

​
enabled
boolean | null

When true, enables typo tolerance for search queries. When false, only exact matches are returned. Defaults to true.

Example:

true

​
minWordSizeForTypos
object

Configures the minimum word length before typos are allowed. Contains oneTypo (min length for 1 typo) and twoTypos (min length for 2 typos) settings.

​
disableOnWords
string[] | null

A list of words for which typo tolerance should be disabled. Use this for brand names, technical terms, or other words that must be matched exactly. Example: ["iPhone", "macOS"].

Example:
["iPhone", "phone"]
​
disableOnAttributes
string[] | null

A list of attributes for which typo tolerance should be disabled. Searches in these attributes will only return exact matches. Useful for fields like product codes or IDs.

Example:
["uuid", "url"]
​
disableOnNumbers
boolean | null

When true, disables typo tolerance on numeric tokens. This prevents numbers like 123 from matching 132. Defaults to false.

Example:

true