Get settings

GET /indexes/{indexUid}/settings

Api key

Get the settings of an index.

Learn more about the settings.

Path parameters

indexUid string Required

Index Unique Identifier

Responses

• 200 application/json

Ok
Hide response attributes Show response attributes object
- rankingRules array[string] Required
  
  List of ranking rules sorted by order of importance. The order is customizable.
  
  A list of ordered built-in ranking rules.
- distinctAttribute string | null Required
  
  Search returns documents with distinct (different) values of the given field.
- searchableAttributes array[string] Required
  
  Fields in which to search for matching query words sorted by order of importance.
- displayedAttributes array[string] Required
  
  Fields displayed in the returned documents.
- stopWords array[string] Required
  
  List of words ignored when present in search queries.
- synonyms object Required
  
  List of associated words treated similarly. A word associated to an array of word as synonyms.
- filterableAttributes array[string] Required
  
  Attributes to use for faceting and filtering. See Filtering and Faceted Search.
- sortableAttributes array[string] Required
  
  List of attributes to sort on at search.
- typoTolerance object Required
  
  Customize typo tolerance feature.
  
  Hide typoTolerance attributes Show typoTolerance attributes
  
  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.
- pagination object Required
  
  Customize pagination settings
  
  Hide pagination attribute Show pagination attribute
  
  maxTotalHits integer
  
  Define the maximum number of documents reachable for a search request. It means that with the default value of 1000, it is not possible to see the 1001st result for a search query.
  
  Default value is 1000.
- faceting object Required
  
  Customize faceting settings
  
  Hide faceting attributes Show faceting attributes
  
  maxValuesPerFacet integer
  
  Define maximum number of value returned for a facet for a search query. It means that with the default value of 100, it is not possible to have 101 different colors if the color` field is defined as a facet at search time.
  
  Default value is 100.
  
  sortFacetValuesBy object
  
  Defines how facet values are sorted. By default, all facets (*) are sorted by name, alphanumerically in ascending order (alpha). count sorts facet values by the number of documents containing a facet value in descending order.
• 401 application/json

Unauthorized
Hide response attributes Show response attributes object
- message string Required
- code string Required
- type string Required
- link string Required
• 404

Not Found

GET /indexes/{indexUid}/settings

curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies/settings \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "rankingRules": [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc"
  ],
  "distinctAttribute": "ean13",
  "searchableAttributes": [
    "title",
    "description",
    "genre"
  ],
  "displayedAttributes": [
    "title",
    "description",
    "genre",
    "release_date"
  ],
  "stopWords": [
    "of",
    "the",
    "to"
  ],
  "synonyms": {
    "wolverine": [
      "xmen",
      "logan"
    ],
    "logan": [
      "wolverine",
      "xmen"
    ],
    "wow": [
      "world of warcraft"
    ]
  },
  "filterableAttributes": [
    "genres",
    "director"
  ],
  "sortableAttributes": [
    "price",
    "author",
    "title"
  ],
  "typoTolerance": {
    "enabled": true,
    "disableOnAttributes": [
      "author",
      "price"
    ],
    "disableOnWords": [
      "Tolkien"
    ],
    "minWordSizeForTypos": {
      "oneTypo": 4,
      "twoTypos": 8
    }
  },
  "pagination": {
    "maxTotalHits": 1000
  },
  "faceting": {
    "maxValuesPerFacet": 100,
    "sortFacetValuesBy": {
      "*": "alpha"
    }
  }
}

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"
}