# Meilisearch Documentation

## Docs

- [List all indexes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/list-all-indexes.md): Returns a paginated list of indexes. Use the `offset` and `limit` query parameters to page through results.
- [Create index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/create-index.md): Create a new index with an optional [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key).
- [Get index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/get-index.md): Retrieve the metadata of a single index: its uid, [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key), and creation/update timestamps.
- [Update index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/update-index.md): Update the [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) or uid of an index.
- [Delete index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/delete-index.md): Permanently delete an index and all its documents, settings, and task history.
- [Swap indexes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/swap-indexes.md): Swap the documents, primary key, settings, and task history of two or more indexes.
- [List index fields](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/list-index-fields.md): Returns a paginated list of fields in the index with their metadata: whether they are displayed, searchable, sortable, filterable, distinct, have a custom ranking rule (asc/desc), and for filterable fields the sort order for facet values.
- [List documents with GET](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/list-documents-with-get.md): Retrieve documents in batches using query parameters for offset, limit, and optional filtering. Suited for browsing or exporting index contents.
- [List documents with POST](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/list-documents-with-post.md): Retrieve a set of documents with optional filtering, sorting, and pagination. Use the request body to specify filters, sort order, and which fields to return.
- [Get document](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/get-document.md): Retrieve a single document by its [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value.
- [Add or replace documents](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/add-or-replace-documents.md): Add a list of documents or replace them if they already exist.
- [Add or update documents](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/add-or-update-documents.md): Add a list of documents or update them if they already exist.
- [Delete document](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/delete-document.md): Delete a single document by its [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key).
- [Delete all documents](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/delete-all-documents.md): Permanently delete all documents in the specified index. Settings and index metadata are preserved.
- [Delete documents by filter](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/delete-documents-by-filter.md): Delete all documents in the index that match the given filter expression.
- [Delete documents by batch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/delete-documents-by-batch.md): Delete multiple documents in one request by providing an array of [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) values.
- [Edit documents by function](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/documents/edit-documents-by-function.md): Use a [RHAI function](https://rhai.rs/book/engine/hello-world.html) to edit one or more documents directly in Meilisearch. The function receives each document and returns the modified document.
- [Search with POST](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search/search-with-post.md): Search for documents matching a query in the given index.
- [Search with GET](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search/search-with-get.md): Search for documents matching a query in the given index.
- [Perform a multi-search](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/multi-search/perform-a-multi-search.md): Run multiple search queries in a single API request.
- [Search in facets](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/facet-search/search-in-facets.md): Search for facet values within a given facet.
- [Get similar documents with POST](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/similar-documents/get-similar-documents-with-post.md): Retrieve documents similar to a reference document identified by its id.
- [Get similar documents with GET](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/similar-documents/get-similar-documents-with-get.md): Retrieve documents similar to a reference document identified by its id.
- [List chat workspaces](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/list-chat-workspaces.md)
- [Get a chat workspace](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/get-a-chat-workspace.md)
- [Delete a chat workspace](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/delete-a-chat-workspace.md)
- [Request a chat completion](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/request-a-chat-completion.md)
- [Get settings of a chat workspace](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/get-settings-of-a-chat-workspace.md)
- [Update settings of a chat workspace](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/update-settings-of-a-chat-workspace.md)
- [Reset the settings of a chat workspace](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/chats/reset-the-settings-of-a-chat-workspace.md)
- [List search rules](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search-rules/list-search-rules.md): Return all search rules configured on the instance.
- [Get a search rule](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search-rules/get-a-search-rule.md): Retrieve a single search rule by its unique identifier.
- [Create or update a search rule](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search-rules/create-or-update-a-search-rule.md): Partially update a search rule by replacing the provided fields. If the rule doesn't exist, it will be created.
- [Delete a search rule](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/search-rules/delete-a-search-rule.md): Delete a search rule by its unique identifier.
- [List tasks](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/list-tasks.md): The `/tasks` route returns information about [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) (indexing, document updates, settings changes, and so on).
- [Get task](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/get-task.md): Retrieve a single [task](https://www.meilisearch.com/docs/learn/async/asynchronous_operations) by its uid.
- [Get task's document payload](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/get-tasks-document-payload.md): Retrieve the document payload that was sent with this [task](https://www.meilisearch.com/docs/learn/async/asynchronous_operations). Only available for document-related tasks that are enqueued or processing.
- [Cancel tasks](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/cancel-tasks.md): Cancel enqueued and/or processing [tasks](https://www.meilisearch.com/docs/learn/async/asynchronous_operations). You must provide at least one filter (e.g. `uids`, `indexUids`, `statuses`) to specify which tasks to cancel.
- [Delete tasks](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/delete-tasks.md): Permanently delete [tasks](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html) matching the given filters. You must provide at least one filter (e.g. `uids`, `indexUids`, `statuses`) to specify which tasks to delete.
- [List batches](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/list-batches.md): Meilisearch groups compatible tasks ([asynchronous operations](https://www.meilisearch.com/docs/learn/async/asynchronous_operations)) into batches for efficient processing.
- [Get batch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/get-batch.md): Meilisearch groups compatible tasks ([asynchronous operations](https://www.meilisearch.com/docs/learn/async/asynchronous_operations)) into batches for efficient processing.
- [List API keys](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/keys/list-api-keys.md): Return all API keys configured on the instance. Results are paginated and can be filtered by offset and limit. The key value itself is never returned after creation.
- [Create API key](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/keys/create-api-key.md): Create a new API key with the specified name, description, actions, and index scopes. The key value is returned only once at creation time; store it securely.
- [Get API key](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/keys/get-api-key.md): Retrieve a single API key by its `uid` or by its `key` value.
- [Update API key](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/keys/update-api-key.md): Update the name and description of an API key.
- [Delete API key](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/keys/delete-api-key.md): Permanently delete the specified API key. The key will no longer be valid for authentication.
- [List all settings](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/list-all-settings.md): Returns all settings of the index. Each setting is returned with its current value or the default if not set.
- [Update all settings](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-all-settings.md): Updates one or more settings for the index. Only the fields sent in the body are changed. Pass null for a setting to reset it to its default. If the index does not exist, it is created.
- [Reset all settings](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-all-settings.md): Resets all settings of the index to their default values.
- [Get chat](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-chat.md): Returns the current value of the `chat` setting for the index.
- [Update chat](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-chat.md): Updates the `chat` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset chat](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-chat.md): Resets the `chat` setting to its default value.
- [Get dictionary](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-dictionary.md): Returns the current value of the `dictionary` setting for the index.
- [Update dictionary](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-dictionary.md): Updates the `dictionary` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset dictionary](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-dictionary.md): Resets the `dictionary` setting to its default value.
- [Get displayedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-displayedattributes.md): Returns the current value of the `displayedAttributes` setting for the index.
- [Update displayedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-displayedattributes.md): Updates the `displayedAttributes` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset displayedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-displayedattributes.md): Resets the `displayedAttributes` setting to its default value.
- [Get distinctAttribute](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-distinctattribute.md): Returns the current value of the `distinctAttribute` setting for the index.
- [Update distinctAttribute](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-distinctattribute.md): Updates the `distinctAttribute` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset distinctAttribute](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-distinctattribute.md): Resets the `distinctAttribute` setting to its default value.
- [Get embedders](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-embedders.md): Returns the current value of the `embedders` setting for the index.
- [Update embedders](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-embedders.md): Updates the `embedders` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset embedders](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-embedders.md): Resets the `embedders` setting to its default value.
- [Get facetSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-facetsearch.md): Returns the current value of the `facetSearch` setting for the index.
- [Update facetSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-facetsearch.md): Updates the `facetSearch` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset facetSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-facetsearch.md): Resets the `facetSearch` setting to its default value.
- [Get faceting](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-faceting.md): Returns the current value of the `faceting` setting for the index.
- [Update faceting](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-faceting.md): Updates the `faceting` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset faceting](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-faceting.md): Resets the `faceting` setting to its default value.
- [Get filterableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-filterableattributes.md): Returns the current value of the `filterableAttributes` setting for the index.
- [Update filterableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-filterableattributes.md): Updates the `filterableAttributes` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset filterableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-filterableattributes.md): Resets the `filterableAttributes` setting to its default value.
- [Get foreignKeys](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-foreignkeys.md): Returns the current value of the `foreignKeys` setting for the index.
- [Update foreignKeys](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-foreignkeys.md): Updates the `foreignKeys` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset foreignKeys](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-foreignkeys.md): Resets the `foreignKeys` setting to its default value.
- [Get localizedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-localizedattributes.md): Returns the current value of the `localizedAttributes` setting for the index.
- [Update localizedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-localizedattributes.md): Updates the `localizedAttributes` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset localizedAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-localizedattributes.md): Resets the `localizedAttributes` setting to its default value.
- [Get nonSeparatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-nonseparatortokens.md): Returns the current value of the `nonSeparatorTokens` setting for the index.
- [Update nonSeparatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-nonseparatortokens.md): Updates the `nonSeparatorTokens` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset nonSeparatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-nonseparatortokens.md): Resets the `nonSeparatorTokens` setting to its default value.
- [Get pagination](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-pagination.md): Returns the current value of the `pagination` setting for the index.
- [Update pagination](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-pagination.md): Updates the `pagination` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset pagination](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-pagination.md): Resets the `pagination` setting to its default value.
- [Get prefixSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-prefixsearch.md): Returns the current value of the `prefixSearch` setting for the index.
- [Update prefixSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-prefixsearch.md): Updates the `prefixSearch` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset prefixSearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-prefixsearch.md): Resets the `prefixSearch` setting to its default value.
- [Get proximityPrecision](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-proximityprecision.md): Returns the current value of the `proximityPrecision` setting for the index.
- [Update proximityPrecision](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-proximityprecision.md): Updates the `proximityPrecision` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset proximityPrecision](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-proximityprecision.md): Resets the `proximityPrecision` setting to its default value.
- [Get rankingRules](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-rankingrules.md): Returns the current value of the `rankingRules` setting for the index.
- [Update rankingRules](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-rankingrules.md): Updates the `rankingRules` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset rankingRules](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-rankingrules.md): Resets the `rankingRules` setting to its default value.
- [Get searchCutoffMs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-searchcutoffms.md): Returns the current value of the `searchCutoffMs` setting for the index.
- [Update searchCutoffMs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-searchcutoffms.md): Updates the `searchCutoffMs` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset searchCutoffMs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-searchcutoffms.md): Resets the `searchCutoffMs` setting to its default value.
- [Get searchableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-searchableattributes.md): Returns the current value of the `searchableAttributes` setting for the index.
- [Update searchableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-searchableattributes.md): Updates the `searchableAttributes` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset searchableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-searchableattributes.md): Resets the `searchableAttributes` setting to its default value.
- [Get separatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-separatortokens.md): Returns the current value of the `separatorTokens` setting for the index.
- [Update separatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-separatortokens.md): Updates the `separatorTokens` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset separatorTokens](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-separatortokens.md): Resets the `separatorTokens` setting to its default value.
- [Get sortableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-sortableattributes.md): Returns the current value of the `sortableAttributes` setting for the index.
- [Update sortableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-sortableattributes.md): Updates the `sortableAttributes` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset sortableAttributes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-sortableattributes.md): Resets the `sortableAttributes` setting to its default value.
- [Get stopWords](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-stopwords.md): Returns the current value of the `stopWords` setting for the index.
- [Update stopWords](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-stopwords.md): Updates the `stopWords` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset stopWords](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-stopwords.md): Resets the `stopWords` setting to its default value.
- [Get synonyms](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-synonyms.md): Returns the current value of the `synonyms` setting for the index.
- [Update synonyms](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-synonyms.md): Updates the `synonyms` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset synonyms](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-synonyms.md): Resets the `synonyms` setting to its default value.
- [Get typoTolerance](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/get-typotolerance.md): Returns the current value of the `typoTolerance` setting for the index.
- [Update typoTolerance](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/update-typotolerance.md): Updates the `typoTolerance` setting for the index. Send the new value in the request body; send null to reset to default.
- [Reset typoTolerance](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/settings/reset-typotolerance.md): Resets the `typoTolerance` setting to its default value.
- [Get stats of index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/get-stats-of-index.md): Return statistics for a single index: document count, database size, indexing status, and field distribution.
- [Get stats of all indexes](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/stats/get-stats-of-all-indexes.md): Return statistics for the Meilisearch instance and for each index. Includes database size, last update time, document counts, and indexing status per index.
- [Get health](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/health/get-health.md): The health check endpoint enables you to periodically test the health of your Meilisearch instance. Returns a simple status indicating that the server is available.
- [Get version](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/version/get-version.md): Return the current Meilisearch version, including the commit SHA and build date.
- [Render documents with POST](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/template/render-documents-with-post.md)
- [Create snapshot](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/backups/create-snapshot.md): Trigger a snapshot creation process. When complete, a snapshot file is written to the snapshot directory. The directory is created if it does not exist.
- [Create dump](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/backups/create-dump.md): Trigger a dump creation process. When complete, a dump file is written to the [dump directory](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#dump-directory). The directory is created if it does not exist.
- [Retrieve logs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/logs/retrieve-logs.md): Stream logs over HTTP. The format of the logs depends on the configuration specified in the payload. The logs are sent as multi-part, and the stream never stops, so ensure your client can handle a long-lived connection. To stop receiving logs, call the `DELETE /logs/stream` route.
- [Stop retrieving logs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/logs/stop-retrieving-logs.md): Call this route to make the engine stop sending logs to the client that opened the `POST /logs/stream` connection.
- [Update target of the console logs](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/logs/update-target-of-the-console-logs.md): Configure at runtime the level of the console logs written to stderr (e.g. debug, info, warn, error).
- [Get Prometheus metrics](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/stats/get-prometheus-metrics.md): Return metrics for the engine in Prometheus format. This is an [experimental feature](https://www.meilisearch.com/docs/learn/experimental/overview) and must be enabled before use.
- [List experimental features](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/experimental-features/list-experimental-features.md): Return all experimental features that can be toggled via this API, and whether each one is currently enabled or disabled.
- [Configure experimental features](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/experimental-features/configure-experimental-features.md): Enable or disable experimental features at runtime.
- [Get network topology](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/experimental-features/get-network-topology.md): Return the list of Meilisearch instances currently known to this node (self and remotes).
- [Configure network topology](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/experimental-features/configure-network-topology.md): Add or remove remote nodes from the network. Changes apply to the current instance’s view of the cluster.
- [Network control](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/experimental-features/network-control.md): Send messages to control the progress of a network topology change task.
- [List webhooks](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/webhooks/list-webhooks.md): Return all webhooks registered on the instance. Each webhook is returned with its URL, optional headers, and UUID (the key value is never returned).
- [Create webhook](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/webhooks/create-webhook.md): Register a new webhook to receive task completion notifications. You can optionally set custom headers (e.g. for authentication) and configure the callback URL.
- [Get webhook](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/webhooks/get-webhook.md): Retrieve a single webhook by its UUID.
- [Update webhook](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/webhooks/update-webhook.md): Update the URL or headers of an existing webhook identified by its UUID.
- [Delete webhook](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/webhooks/delete-webhook.md): Permanently remove a webhook by its UUID. The webhook will no longer receive task notifications.
- [Compact index](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/indexes/compact-index.md): Trigger a compaction process on the specified index.
- [Compact task queue](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/async-task-management/compact-task-queue.md): Trigger a compaction process on the task queue database and return its size before and after compaction. A successful compaction requires restarting the instance before it can safely resume normal writes.
- [Export to a remote Meilisearch](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/reference/api/export/export-to-a-remote-meilisearch.md): Trigger an export that sends documents and settings from this instance to a remote Meilisearch server. Configure the remote URL and optional API key in the request body.

## OpenAPI Specs

- [meilisearch-openapi](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/assets/open-api/meilisearch-openapi.json)
- [meilisearch-openapi-mintlify](https://meilisearch-6b28dec2-add-platform-documentation.mintlify.site/assets/open-api/meilisearch-openapi-mintlify.json)