Search documents, configure and manage the MeiliSearch engine.
This is the documentation for version 0.22.0
of the API. Last update on Sep 13, 2021.
This API is provided under license MIT.
https://example.meilisearch.com:7700An index is an entity that gathers a set of documents with its own settings.
Learn more about indexes.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes[
{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X POST https://example.meilisearch.com:7700/indexes \
-H "Content-Type: application/json" \
-d '{"uid":"movies","primaryKey":"movie_id"}'{
"uid": "movies",
"primaryKey": "movie_id"
}{
"message": "Index already exists.",
"errorCode": "index_already_exists",
"errorType": "invalid_request_error",
"errorLink": "https://docs.meilisearch.com/errors#index_already_exists"
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X PUT https://example.meilisearch.com:7700/indexes/{indexUid} \
-H "Content-Type: application/json" \
-d '{"primaryKey":"string"}'{
"primaryKey": "string"
}{
"message": "A primary key is already present. It's impossible to update it",
"errorCode": "primary_key_already_present",
"errorType": "invalid_request_error",
"errorLink": "https://docs.meilisearch.com/errors#primary_key_already_present"
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Documents are objects composed of fields that can store any type of data.
Each field contains an attribute and its associated value.
Documents are stored inside indexes.
Learn more about documents.
Comma-separated list of attributes whose fields will be present in the returned documents. Defaults to the displayedAttributes list which contains by default all attributes found in the documents.
Default value is *.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/documents[
{
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01"
}
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Add a list of documents or update them if they already exist.
If you send an already existing document (same id) the old document will be only partially updated according to the fields of the new document. Thus, any fields not present in the new document are kept and remained unchanged.
To completely overwrite a document, see Add or replace documents route.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X PUT https://example.meilisearch.com:7700/indexes/{indexUid}/documents \
-H "Content-Type: application/json" \
-d '[{"id":25684,"title":"American Ninja 5","poster":"https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg","overview":"When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.","release_date":"1993-01-01"}]'[
{
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01"
}
]{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Payload reached size limit.",
"errorCode": "payload_too_large",
"errorType": "invalid_request_error",
"errorLink": "https://docs.meilisearch.com/errors#payload_too_large"
}Add a list of documents or replace them if they already exist.
If you send an already existing document (same id) the whole existing document will be overwritten by the new document. Fields previously in the document not present in the new document are removed.
For a partial update of the document see Add or update documents route.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/documents \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Payload reached size limit.",
"errorCode": "payload_too_large",
"errorType": "invalid_request_error",
"errorLink": "https://docs.meilisearch.com/errors#payload_too_large"
}This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/documents{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/documents/delete-batch \
-H "Content-Type: application/json" \
-d '[1,2,3,"a string id"]'[
1,
2,
3,
"a string id"
]{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/documents/{documentId}{
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01"
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/documents/{documentId}{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}MeiliSearch exposes 2 routes to perform searches:
Search for documents matching a specific query in the given index.
This route should only be used when no API key is required. If an API key is required, use the POST route instead.
Comma-separated list of attributes whose fields will be present in the returned documents. Defaults to the displayedAttributes list which contains by default all attributes found in the documents.
Default value is *.
Comma-separated list of attributes whose fields will be distributed as a facet. If you have set up filterableAttributes, you can retrieve the count of matching terms for each facets.Learn more about facet distribution in the dedicated guide
Attribute(s) to filter on.
Can be made of 3 syntaxes
["something > 1", "genres=comedy", ["genres=horror", "title=batman"]]something > 1 AND genres=comedy AND (genres=horror OR title=batman)["something > 1 AND genres=comedy", "genres=horror OR title=batman"]Attribute(s) used in filter should be declared as filterable attributes. See Filtering and Faceted Search.
Fields on which you want to sort the results.
Attribute(s) used in sort should be declared as sortable attributes. See Sorting.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/search{
"hits": [
{
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01",
"_formatted": {
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.",
"release_date": "1993-01-01"
},
"_matchesInfo": {
"overview": [
{
"start": 49,
"length": 5
},
{
"start": 155,
"length": 5
}
]
}
}
],
"limit": 0,
"offset": 0,
"nbHits": 0,
"query": "string",
"exhaustiveNbHits": true,
"processingTimeMs": 0
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Search for documents matching a specific query in the given index.
This is the preferred route to perform search when an API key is required, as it allows for preflight requests to be cached. Caching preflight requests improves considerably the speed of the search.
Array of attributes whose fields will be present in the returned documents. Defaults to the displayedAttributes list which contains by default all attributes found in the documents.
Default value is ["*"].
Attribute(s) to filter on.
Can be made of 3 syntaxes
["something > 1", "genres=comedy", ["genres=horror", "title=batman"]]"something > 1 AND genres=comedy AND (genres=horror OR title=batman)"["something > 1 AND genres=comedy", "genres=horror OR title=batman"]Attribute(s) used in filter should be declared as filterable attributes. See Filtering and Faceted Search.
Array of attributes whose fields will be distributed as a facet. If you have set up filterableAttributes, you can retrieve the count of matching terms for each facets.Learn more about facet distribution in the dedicated guide
Default value is [].
Fields on which you want to sort the results.
Attribute(s) used in sort should be declared as sortable attributes. See Sorting.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/search \
-H "Content-Type: application/json" \
-d '{"q":"Harry","offset":0,"limit":20,"filter":"(genres = Horror AND genres = Mystery) OR release_date \u003e 523242000","facetsDistribution":["genres","author"],"attributesToRetrieve":["title","overview"],"attributesToCrop":["overview"],"cropLength":20,"attributesToHighlight":["overview"],"matches":true}'{
"q": "Harry",
"offset": 0,
"limit": 20,
"filter": "(genres = Horror AND genres = Mystery) OR release_date > 523242000",
"facetsDistribution": [
"genres",
"author"
],
"attributesToRetrieve": [
"title",
"overview"
],
"attributesToCrop": [
"overview"
],
"cropLength": 20,
"attributesToHighlight": [
"overview"
],
"matches": true
}{
"hits": [
{
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01",
"_formatted": {
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.",
"release_date": "1993-01-01"
},
"_matchesInfo": {
"overview": [
{
"start": 49,
"length": 5
},
{
"start": 155,
"length": 5
}
]
}
}
],
"limit": 0,
"offset": 0,
"nbHits": 0,
"query": "string",
"exhaustiveNbHits": true,
"processingTimeMs": 0
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}The updates route gives information about the progress of the asynchronous processes.
List of ranking rules sorted by order of importance. The order is customizable.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
A string describing the error that occurred.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/updates[
{
"status": "processed",
"updateId": 0,
"type": {
"name": "DocumentsAddition",
"number": 6
},
"duration": 0.031,
"enqueuedAt": "2021-07-05T12:59:17.035788Z",
"processedAt": "2021-07-05T12:59:17.067453Z"
},
{
"status": "processed",
"updateId": 1,
"type": {
"name": "DocumentsAddition",
"number": 6
},
"duration": 0.043,
"enqueuedAt": "2021-07-06T07:45:49.883179Z",
"processedAt": "2021-07-06T07:45:49.927102Z"
},
{
"status": "processed",
"updateId": 2,
"type": {
"name": "Settings",
"settings": {
"searchableAttributes": [
"name",
"genre"
],
"stopWords": [
"of",
"the"
],
"synonyms": {
"HP": [
"Harry Potter"
],
"harry potter": [
"HP"
]
},
"distinctAttribute": "name"
}
},
"duration": 0.042,
"enqueuedAt": "2021-07-19T15:21:44.984611Z",
"processedAt": "2021-07-19T15:21:45.027818Z"
}
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}List of ranking rules sorted by order of importance. The order is customizable.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
A string describing the error that occurred.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/updates/{updateId}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Each instance of MeiliSearch has three keys: a master, a private, and a public. Each key has a given set of permissions on the API routes.
You must have the master key to access the keys route.
More information about the keys and their rights.
$ curl \
-X GET https://example.meilisearch.com:7700/keys{
"private": "string",
"public": "string"
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Settings is a list of all the customization possible for an index.
It is possible to update all the settings in one go or individually with the dedicated routes. Updates in the settings route are partial. This means that any parameters not provided in the body will be left unchanged.
Updating the settings means overwriting the default settings of MeiliSearch. You can reset to default values using the DELETE routes.
List of ranking rules sorted by order of importance. The order is customizable.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings{
"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"
]
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the settings of an index.
Updates in the settings route are partial. This means that any parameters not provided in the body will be left unchanged.
Learn more about the settings in this guide.
If the provided index does not exist, it will be created.
List of ranking rules sorted by order of importance. The order is customizable.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings \
-H "Content-Type: application/json" \
-d '{"synonyms":{"wolverine":["xmen","logan"],"logan":["wolverine","xmen"],"wow":["world of warcraft"]},"stopWords":["of","the","to"],"rankingRules":["words","typo","proximity","attribute","sort","exactness","release_date:asc"],"distinctAttribute":"ean13","searchableAttributes":["title","description","genre"],"displayedAttributes":["title","description","genre","release_date"],"filterableAttributes":[],"sortableAttributes":null}'{
"synonyms": {
"wolverine": [
"xmen",
"logan"
],
"logan": [
"wolverine",
"xmen"
],
"wow": [
"world of warcraft"
]
},
"stopWords": [
"of",
"the",
"to"
],
"rankingRules": [
"words",
"typo",
"proximity",
"attribute",
"sort",
"exactness",
"release_date:asc"
],
"distinctAttribute": "ean13",
"searchableAttributes": [
"title",
"description",
"genre"
],
"displayedAttributes": [
"title",
"description",
"genre",
"release_date"
],
"filterableAttributes": [],
"sortableAttributes": null
}{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms{
"wolverine": [
"xmen",
"logan"
],
"logan": [
"wolverine",
"xmen"
],
"wow": [
"world of warcraft"
]
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the list of synonyms of an index. Synonyms are normalized.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes[
"price",
"author",
"title"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the list of sortableAttributes of an index to its default value ([]).
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/stop-words[
"of",
"the",
"to"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the list of stop-words of an index.
If a list of stop-words already exists it will be overwritten (replaced).
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/stop-words \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/stop-words{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/ranking-rules[
"words",
"typo",
"proximity",
"attribute",
"sort",
"exactness",
"release_date:asc"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the ranking rules of an index.
To add your own ranking rule, you have to communicate either asc for ascending order or desc for descending order followed by the field name in brackets.
attribute_name:ascattribute_name:descIf the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/ranking-rules \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the ranking rules of an index to its default value.
Default Value:
["words", "typo", "proximity", "attribute", "sort", "exactness"]
To remove all ranking rules, which is not recommended in any case, you would send an empty array to the add or replace ranking rules route.
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/ranking-rules{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/filterable-attributes[
"genres",
"director"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the filterable attributes of an index.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/filterable-attributes \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the filterable attributes of an index to its default value ([]).
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/filterable-attributes{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/distinct-attribute{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the distinct attribute field of an index.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/distinct-attribute \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the distinct attribute field of an index to its default value (null).
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/distinct-attribute{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/searchable-attributes[
"title",
"description",
"genre"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the searchable attributes of an index.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/searchable-attributes \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the searchable attributes of an index to its default value (['*']).
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/searchable-attributes{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/displayed-attributes[
"title",
"description",
"genre",
"release_date"
]{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Update the displayed attributes of an index.
If the provided index does not exist, it will be created.
This updateId allows you to track the current update.
$ curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/displayed-attributes \
-H "Content-Type: application/json"{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Reset the displayed attributes of an index to its default value (['*']).
This updateId allows you to track the current update.
$ curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/displayed-attributes{
"updateId": 1
}{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}Stats gives extended information and metrics about indexes and the MeiliSearch database.
$ curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/stats{
"message": "You must have an authorization token",
"errorCode": "missing_authorization_header",
"errorType": "authentication_error",
"errorLink": "https://docs.meilisearch.com/errors#missing_authorization_header"
}