List all settings

Returns all settings of the index. Each setting is returned with its current value or the default if not set.

GET /indexes/{index_uid}/settings

cURL

cURL

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings'

import requests

url = "http://localhost:7700/indexes/{index_uid}/settings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:7700/indexes/{index_uid}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/indexes/{index_uid}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:7700/indexes/{index_uid}/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:7700/indexes/{index_uid}/settings")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:7700/indexes/{index_uid}/settings")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "displayedAttributes": [
    "id",
    "title",
    "description",
    "url"
  ],
  "searchableAttributes": [
    "title",
    "description"
  ],
  "filterableAttributes": [
    "release_date",
    "genre"
  ],
  "sortableAttributes": [
    "release_date"
  ],
  "rankingRules": [
    "words",
    "typo",
    "proximity",
    "attributeRank",
    "sort",
    "wordPosition",
    "exactness"
  ],
  "stopWords": [
    "the",
    "a"
  ],
  "nonSeparatorTokens": [
    "@",
    "#"
  ],
  "separatorTokens": [
    "|"
  ],
  "dictionary": [
    "J. R. R."
  ],
  "synonyms": {
    "phone": [
      "iPhone"
    ]
  },
  "distinctAttribute": null,
  "typoTolerance": {
    "enabled": true,
    "minWordSizeForTypos": {
      "oneTypo": 5,
      "twoTypos": 9
    },
    "disableOnWords": [],
    "disableOnAttributes": [
      "title"
    ],
    "disableOnNumbers": false
  },
  "faceting": {
    "maxValuesPerFacet": 100,
    "sortFacetValuesBy": {
      "genre": "count"
    }
  },
  "pagination": {
    "maxTotalHits": 1000
  },
  "proximityPrecision": "byWord",
  "embedders": {
    "default": {
      "source": "openAi",
      "model": "text-embedding-3-small",
      "documentTemplate": "{{doc.title}}: {{doc.overview}}"
    }
  },
  "searchCutoffMs": null,
  "localizedAttributes": [
    {
      "locales": [
        "jpn"
      ],
      "attributePatterns": [
        "*_ja"
      ]
    }
  ],
  "facetSearch": true,
  "prefixSearch": "indexingTime",
  "chat": {
    "description": "A comprehensive movie database",
    "documentTemplateMaxBytes": 400,
    "searchParameters": {
      "limit": 20
    }
  }
}

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

{
  "message": "Index `movies` not found.",
  "code": "index_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors#index_not_found"
}

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

index_uid · string · required

Unique identifier of the index.

Response

200

application/json

Returns all settings with their current or default values. Same structure as the PATCH request body.

Index settings: every option you can configure for search and index behavior.

Used as the request body for PATCH settings. Only the fields you send are updated; pass null to reset a setting to its default.

See also: Configuring index settings on the Cloud.

displayedAttributes · string[] | null

Fields returned in search results. Affects only search endpoints, not get-document endpoints. See displayed and searchable attributes.

Example:

["id", "title", "description", "url"]

searchableAttributes · string[] | null

Fields searched for query words, in order of importance. Defines attribute ranking order. See displayed and searchable attributes.

Example:

["title", "description"]

filterableAttributes · (string | object)[] | null

Attributes that can be used as filters and facets. Strings or objects with attributePatterns and features.

Example:

["release_date", "genre"]

sortableAttributes · string[] | null

Attributes that can be used to sort search results.

Example:

["release_date"]

foreignKeys · object[] | null

Foreign keys to use for cross-index filtering search.

Show child attributes

Example:

[
  {
    "foreignIndexUid": "products",
    "fieldName": "productId"
  }
]

rankingRules · string[] | null

Ranking rules in order of importance. Built-in rules and custom sort rules (attribute:asc or attribute:desc).

Example:

[
  "words",
  "typo",
  "proximity",
  "attributeRank",
  "sort",
  "wordPosition",
  "exactness"
]

stopWords · string[] | null

Words ignored when present in search queries.

Example:

["the", "a"]

nonSeparatorTokens · string[] | null

Characters that are not treated as word separators. Removed from the default separator set.

Example:

["@", "#"]

separatorTokens · string[] | null

Characters that delimit words. Added on top of the default separators.

Example:

["|"]

dictionary · string[] | null

Strings Meilisearch parses as a single term. Useful for names or domain terms.

Example:

["J. R. R."]

synonyms · object | null

Pairs of words or phrases treated as equivalent for search. Key maps to an array of synonyms.

Show child attributes

Example:

{ "phone": ["iPhone"] }

distinctAttribute · string | null

Field whose value must be unique in the returned documents. One document per distinct value. See distinct attribute.

Example:

"sku"

proximityPrecision · string | null · default: byWord

Precision for the proximity ranking rule and phrase search: byWord (exact distance) or byAttribute (same attribute).

Example:

"byWord"

typoTolerance · null | object

Typo tolerance: enable/disable, minimum word length for typos, and where to disable it.

Show child attributes

faceting · null | object

Related to faceting: max facet values per facet and how facet values are sorted.

Show child attributes

pagination · null | object

Related to pagination: maximum number of results a search can return.

Show child attributes

embedders · object | null

Embedders used for semantic and hybrid search. Map of embedder name to config (source, model, documentTemplate, etc.).

Show child attributes

Example:

{
  "default": {
    "source": "openAi",
    "model": "text-embedding-3-small",
    "documentTemplate": "{{doc.title}}: {{doc.overview}}"
  }
}

searchCutoffMs · integer<u-int64> | null

Maximum duration of a search in milliseconds. If reached, the search stops and returns results computed so far. When null, 1500 ms is used.

Required range: x >= 0

Example:

1500

localizedAttributes · object[] | null

Locales and attribute patterns for language-specific tokenization. Affects searchable, filterable, and sortable attributes.

Show child attributes

Example:

[
  {
    "locales": ["jpn"],
    "attributePatterns": ["*_ja"]
  }
]

facetSearch · boolean | null · default: true

When true, facet search is enabled. When false, the facet-search endpoint is disabled.

Example:

true

prefixSearch · null | enum<string> · default: indexingTime

When to compute prefix matches: indexingTime or disabled. disabled speeds up indexing but reduces relevancy.

Available options: indexingTime, disabled

chat · null | object

Chat (conversation) settings: index description, document template, and search parameters used when the LLM queries this index.

Show child attributes