Search documents, configure and manage the Meilisearch engine.
This is the documentation for version 0.25.0
of the API. Last update on Jan 26, 2022.
This API is provided under license MIT.
https://example.meilisearch.com:7700An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.
Example: Authorization: Bearer 8fece4405662dd830e4cb265e7e047aab2e79672a760a12712d2a263c9003509
An 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 \
-H "Authorization: Bearer $ACCESS_TOKEN"[
{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}
]{
"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"
}Payload content-type
Values are application/json.
curl \
-X POST https://example.meilisearch.com:7700/indexes \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"uid":"movies","primaryKey":"movie_id"}'# Headers
Content-Type: application/json
# Payload
{
"uid": "movies",
"primaryKey": "movie_id"
}{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}{
"message": "Index `:indexUid` already exists.",
"code": "index_already_exists",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_already_exists"
}{
"message": "`:indexUid` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
"code": "invalid_index_uid",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#invalid_index_uid"
}{
"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"
}curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}{
"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"
}Payload content-type
Values are application/json.
curl \
-X PUT https://example.meilisearch.com:7700/indexes/{indexUid} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"primaryKey":"string"}'# Headers
Content-Type: application/json
# Payload
{
"primaryKey": "string"
}{
"uid": "movies",
"name": "movies",
"primaryKey": "movie_id",
"createdAt": "2019-11-20T09:40:33.711324Z",
"updatedAt": "2019-11-20T09:40:33.711324Z"
}{
"message": "Index `:indexUid` already has a primary key.",
"code": "index_primary_key_already_exists",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_primary_key_already_exists"
}{
"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"
}curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"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"
}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.
Maximum number of documents to return.
Default value is 20.
Number of documents to skip.
Default value is 0.
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 \
-H "Authorization: Bearer $ACCESS_TOKEN"[
{
"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": "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"
}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.
Use the reserved _geo object to add geo coordinates to a document. _geo is an object made of lat and lng field.
The content-type associated with the format to be indexed
Values are application/json, text/csv, or application/x-ndjson.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Payload Too Large
curl \
-X PUT https://example.meilisearch.com:7700/indexes/{indexUid}/documents \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-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"}]'# Headers
Content-Type: application/json
# Payload
[
{
"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"
}
]{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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": "The provided payload reached the size limit.",
"code": "payload_too_large",
"type": "invalid_request",
"link": "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.
Use the reserved _geo object to add geo coordinates to a document. _geo is an object made of lat and lng field.
The content-type associated with the format to be indexed
Values are application/json, text/csv, or application/x-ndjson.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Payload Too Large
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/documents \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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": "The provided payload reached the size limit.",
"code": "payload_too_large",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#payload_too_large"
}Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/documents \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}Payload content-type
Values are application/json.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/documents/delete-batch \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '[1,2,3,"a string id"]'# Headers
Content-Type: application/json
# Payload
[
1,
2,
3,
"a string id"
]{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/documents/{documentId} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"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": "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"
}Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/documents/{documentId} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}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.
Query string.
Default value is "".
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 values will contain highlighted matching terms. Highlighted attributes are returned in _formatted response object.
Comma-separated list of attributes whose values have to be cropped. Cropped attributes are returned in _formatted response object.
Length used to crop field values.
Default value is 200.
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"]_geoRadius({lat}, {lng}, {distance_in_meters}) built-in filter rule can be used to filter documents within a geo circle.
Attribute(s) used in filter should be declared as filterable attributes. See Filtering and Faceted Search.
Number of documents to skip.
Default value is 0.
Maximum number of documents to return.
Default value is 20.
Defines whether an _matchesInfo object that contains information about the matches should be returned or not.
Default value is false.
Ok
Array of documents matching the search.
Only present if attributesToHighlight/attributesToCrop is not empty. Return highlighted and cropped fields.
Only present if matches = true. Array of all search query occurrences in all fields.
Retrieve attributes of the document. attributesToRetrieve controls these fields.
Using _geoPoint({lat}, {lng}) built-in sort rule at search leads the engine to return a _geoDistance within the search results. This field represents the distance in meters of the document from the specified _geoPoint.
Number of documents skipped.
Number of returned documents.
Total number of candidates for this search in the database.
Whether nbHits is exhaustive.
Whether facetsDistribution is exhaustive.
Processing time of the query.
Query originating the response.
Unauthorized
Not Found
curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/search \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"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": "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"
}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.
Payload content-type
Values are application/json.
Query string.
Default value is "".
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 ["*"].
Array of attributes whose values will contain highlighted matching terms. Highlighted attributes are returned in _formatted response object.
Default value is [].
Array of attributes whose values have to be cropped. Cropped attributes are returned in _formatted response object.
Default value is [].
Length used to crop field values.
Default value is 200.
Defines whether an _matchesInfo object that contains information about the matches should be returned or not.
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"]_geoRadius({lat}, {lng}, {distance_in_meters}) built-in filter rule can be used to filter documents within a geo circle.
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 [].
Number of documents to skip.
Default value is 0.
Maximum number of documents returned.
Default value is 20.
Ok
Array of documents matching the search.
Only present if attributesToHighlight/attributesToCrop is not empty. Return highlighted and cropped fields.
Only present if matches = true. Array of all search query occurrences in all fields.
Retrieve attributes of the document. attributesToRetrieve controls these fields.
Using _geoPoint({lat}, {lng}) built-in sort rule at search leads the engine to return a _geoDistance within the search results. This field represents the distance in meters of the document from the specified _geoPoint.
Number of documents skipped.
Number of returned documents.
Total number of candidates for this search in the database.
Whether nbHits is exhaustive.
Whether facetsDistribution is exhaustive.
Processing time of the query.
Query originating the response.
Unauthorized
Not Found
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/search \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-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}'# Headers
Content-Type: application/json
# Payload
{
"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": "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"
}The tasks route gives information about the progress of the asynchronous operations.
Ok
The unique sequential identifier of the task
The unique identifier of the index where this task is operated
The status of the task
Values are enqueued, processing, succeeded, or failed.
The type of the task
Values are documentAddition, documentPartial, documentDeletion, indexCreation, indexUpdate, indexDeletion, settingsUpdate, or clearAll.
Details information of the task payload.
Number of documents received for documentAddition or documentPartial task.
Number of documents finally indexed for documentAddition or documentPartial task.
Number of document ids received for documentDeletion task.
Number of documents finally deleted for documentDeletion, indexDeletion or clearAll task.
Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
List of associated words treated similarly. A word associated to an array of word as synonyms.
List of words ignored when present in search queries.
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.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
Total elasped time the engine was in processing state expressed as a ISO-8601 duration format. Default is set to null
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/tasks \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"uid": 1,
"indexUid": "movies",
"status": "succeeded",
"type": "documentAddition",
"details": {
"receivedDocuments": 79000,
"indexedDocuments": 79000
},
"duration": "PT2S",
"enqueuedAt": "2021-01-01T09:39:00.000000Z",
"startedAt": "2021-01-01T09:39:01.000000Z",
"finishedAt": "2021-01-01T09:39:02.000000Z"
},
{
"uid": 0,
"indexUid": "movies",
"status": "failed",
"type": "documentAddition",
"details": {
"receivedDocuments": 67493,
"indexedDocuments": 0
},
"error": {
"message": "Document does not have a `:primaryKey` attribute: `:documentRepresentation`.",
"code": "missing_document_id",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#missing_document_id"
},
"duration": "PT5S",
"enqueuedAt": "2021-01-01T09:38:00.000000Z",
"startedAt": "2021-01-01T09:38:02.000000Z",
"finishedAt": "2021-01-01T09:38:07.000000Z"
}
]
}{
"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"
}Ok
The unique sequential identifier of the task
The unique identifier of the index where this task is operated
The status of the task
Values are enqueued, processing, succeeded, or failed.
The type of the task
Values are documentAddition, documentPartial, documentDeletion, indexCreation, indexUpdate, indexDeletion, settingsUpdate, or clearAll.
Details information of the task payload.
Number of documents received for documentAddition or documentPartial task.
Number of documents finally indexed for documentAddition or documentPartial task.
Number of document ids received for documentDeletion task.
Number of documents finally deleted for documentDeletion, indexDeletion or clearAll task.
Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
List of associated words treated similarly. A word associated to an array of word as synonyms.
List of words ignored when present in search queries.
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.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
Total elasped time the engine was in processing state expressed as a ISO-8601 duration format. Default is set to null
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/tasks/{taskUid} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 1,
"indexUid": "movies",
"status": "succeeded",
"type": "documentAddition",
"details": {
"receivedDocuments": 79000,
"indexedDocuments": 79000
},
"duration": "PT1S",
"enqueuedAt": "2021-01-01T09:39:00.000000Z",
"startedAt": "2021-01-01T09:39:01.000000Z",
"finishedAt": "2021-01-01T09:39:02.000000Z"
}{
"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"
}OK
The unique sequential identifier of the task
The unique identifier of the index where this task is operated
The status of the task
Values are enqueued, processing, succeeded, or failed.
The type of the task
Values are documentAddition, documentPartial, documentDeletion, indexCreation, indexUpdate, indexDeletion, settingsUpdate, or clearAll.
Details information of the task payload.
Number of documents received for documentAddition or documentPartial task.
Number of documents finally indexed for documentAddition or documentPartial task.
Number of document ids received for documentDeletion task.
Number of documents finally deleted for documentDeletion, indexDeletion or clearAll task.
Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
List of associated words treated similarly. A word associated to an array of word as synonyms.
List of words ignored when present in search queries.
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.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
Total elasped time the engine was in processing state expressed as a ISO-8601 duration format. Default is set to null
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
curl \
-X GET https://example.meilisearch.com:7700/tasks \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"uid": 1,
"indexUid": "movies",
"status": "succeeded",
"type": "documentAddition",
"details": {
"receivedDocuments": 79000,
"indexedDocuments": 79000
},
"duration": "PT1S",
"enqueuedAt": "2021-01-01T09:39:00.000000Z",
"startedAt": "2021-01-01T09:39:01.000000Z",
"finishedAt": "2021-01-01T09:39:02.000000Z"
},
{
"uid": 0,
"indexUid": "movies_Review",
"status": "failed",
"type": "documentAddition",
"details": {
"receivedDocuments": 67493,
"indexedDocuments": 0
},
"error": {
"message": "Document does not have a `:primaryKey` attribute: `:documentRepresentation`.",
"code": "missing_document_id",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#missing_document_id"
},
"duration": "PT5S",
"enqueuedAt": "2021-01-01T09:38:00.000000Z",
"startedAt": "2021-01-01T09:38:02.000000Z",
"finishedAt": "2021-01-01T09:38:07.000000Z"
}
]
}OK
The unique sequential identifier of the task
The unique identifier of the index where this task is operated
The status of the task
Values are enqueued, processing, succeeded, or failed.
The type of the task
Values are documentAddition, documentPartial, documentDeletion, indexCreation, indexUpdate, indexDeletion, settingsUpdate, or clearAll.
Details information of the task payload.
Number of documents received for documentAddition or documentPartial task.
Number of documents finally indexed for documentAddition or documentPartial task.
Number of document ids received for documentDeletion task.
Number of documents finally deleted for documentDeletion, indexDeletion or clearAll task.
Value for the primaryKey field encountered if any for indexCreation or indexUpdate task.
List of associated words treated similarly. A word associated to an array of word as synonyms.
List of words ignored when present in search queries.
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.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
Total elasped time the engine was in processing state expressed as a ISO-8601 duration format. Default is set to null
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X GET https://example.meilisearch.com:7700/tasks/:taskUid \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 1,
"indexUid": "movies",
"status": "succeeded",
"type": "documentAddition",
"details": {
"receivedDocuments": 79000,
"indexedDocuments": 79000
},
"duration": "PT1S",
"enqueuedAt": "2021-01-01T09:39:00.000000Z",
"startedAt": "2021-01-01T09:39:01.000000Z",
"finishedAt": "2021-01-01T09:39:02.000000Z"
}{
"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": "Task :taskUid not found.",
"code": "task_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors/#task_not_found"
}Manage API keys for a Meilisearch instance. Each key has a given set of permissions.
You must have the master key to access the keys route.
More information about the keys and their rights.
Ok
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
Unauthorized
curl \
-X GET https://example.meilisearch.com:7700/keys \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"key": "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4",
"actions": [
"documents.add"
],
"indexes": [
"movies"
],
"description": "An API Key",
"expiresAt": "2022-11-12T10:00:00Z",
"createdAt": "2021-11-12T10:00:00Z",
"updatedAt": "2021-11-12T10:00:00Z"
}
]
}{
"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"
}OK
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
curl \
-X GET https://example.meilisearch.com:7700/keys/{key} \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"description": "Indexing Products API key",
"key": "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4",
"actions": [
"documents.add"
],
"indexes": [
"products"
],
"expiresAt": "2021-11-13T00:00:00Z",
"createdAt": "2021-11-12T10:00:00Z",
"updatedAt": "2021-11-12T10:00:00Z"
}Payload content-type
Values are application/json.
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
OK
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
curl \
-X POST https://example.meilisearch.com:7700/keys/{key} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"description":"Indexing Products API key","actions":["documents.add"],"indexes":["products"],"expiresAt":"2021-11-13T00:00:00Z"}'# Headers
Content-Type: application/json
# Payload
{
"description": "Indexing Products API key",
"actions": [
"documents.add"
],
"indexes": [
"products"
],
"expiresAt": "2021-11-13T00:00:00Z"
}{
"description": "Indexing Products API key",
"key": "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4",
"actions": [
"documents.add"
],
"indexes": [
"products"
],
"expiresAt": "2021-11-13T00:00:00Z",
"createdAt": "2021-11-12T10:00:00Z",
"updatedAt": "2021-11-12T10:00:00Z"
}curl \
-X DELETE https://example.meilisearch.com:7700/keys/{key} \
-H "Authorization: Bearer $ACCESS_TOKEN"Payload content-type
Values are application/json.
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
OK
The generated key. Generated by Meilisearch.
A list of actions permitted for the key. ["*"] for all actions.
Values are search, documents.add, documents.get, documents.delete, indexes.create, indexes.get, indexes.update, indexes.delete, tasks.get, settings.get, settings.update, stats.get, dumps.create, dumps.get, or version.
A list of accesible indexes permitted for the key. ["*"] for all indexes.
A description for the key. null if empty.
Represent the expiration date and time as ISO-8601 format. null equals to no expiration time.
Represent the date and time as ISO-8601 format when the API key has been created. Generated by Meilisearch.
Represent the date and time as ISO-8601 format when the API key has been updated. Generated by Meilisearch.
curl \
-X PATCH https://example.meilisearch.com:7700/keys/{key} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"description":"Indexing Products API key"}'# Headers
Content-Type: application/json
# Payload
{
"description": "Indexing Products API key"
}{
"description": "Indexing Products API key",
"key": "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4",
"actions": [
"documents.add"
],
"indexes": [
"products"
],
"expiresAt": "2021-11-13T00:00:00Z",
"createdAt": "2021-11-12T10:00:00Z",
"updatedAt": "2021-11-12T15:00:00Z"
}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.
Ok
List of ranking rules sorted by order of importance. The order is customizable.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
List of words ignored when present in search queries.
List of associated words treated similarly. A word associated to an array of word as synonyms.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
List of attributes to sort on at search.
Unauthorized
Not Found
curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"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": "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"
}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.
Payload content-type
Values are application/json.
List of associated words treated similarly. A word associated to an array of word as synonyms.
List of words ignored when present in search queries.
List of ranking rules sorted by order of importance. The order is customizable.
Search returns documents with distinct (different) values of the given field.
Fields in which to search for matching query words sorted by order of importance.
Fields displayed in the returned documents.
Attributes to use for facetting and filtering. See Filtering and Faceted Search.
List of attributes to sort on at search.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-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}'# Headers
Content-Type: application/json
# Payload
{
"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
}{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}Reset the settings of an index.
All settings will be reset to their default value.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"wolverine": [
"xmen",
"logan"
],
"logan": [
"wolverine",
"xmen"
],
"wow": [
"world of warcraft"
]
}{
"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"
}Update the list of synonyms of an index. Synonyms are normalized.
If the provided index does not exist, it will be created.
Payload content-type
Values are application/json.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"wolverine":["xmen","logan"],"logan":["wolverine","xmen"],"wow":["world of warcraft"]}'# Headers
Content-Type: application/json
# Payload
{
"wolverine": [
"xmen",
"logan"
],
"logan": [
"wolverine",
"xmen"
],
"wow": [
"world of warcraft"
]
}{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/synonyms \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes \
-H "Authorization: Bearer $ACCESS_TOKEN"[
"price",
"author",
"title"
]{
"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"
}Update the list of sortableAttributes of an index.
In order to enable sorting capabilities on geographic data, the _geo field must be added as a sortableAttribute.
Payload content-type
Values are application/json.
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X POST https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '["price","author","title"]'# Headers
Content-Type: application/json
# Payload
[
"price",
"author",
"title"
]{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}Reset the list of sortableAttributes of an index to its default value ([]).
Accepted
This uid allows you to track the current task.
The unique identifier of the index where this task is operated
The status of the task
An ISO-8601 format for date/time/duration.
Unauthorized
Not Found
curl \
-X DELETE https://example.meilisearch.com:7700/indexes/{indexUid}/settings/sortable-attributes \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"uid": 0,
"indexUid": "movies",
"status": "enqueued",
"enqueuedAt": "2021-07-19T14:31:16.920473Z"
}{
"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"
}curl \
-X GET https://example.meilisearch.com:7700/indexes/{indexUid}/settings/stop-words \
-H "Authorization: Bearer $ACCESS_TOKEN"[
"of",
"the",
"to"
]{
"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"
}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.
Payload content-type
Values are application/json.