Show Menu
Search…
Ctrl+K
ESC
Example searches: “400”, “limit”, “number”, “code”, “null”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Topics
Introduction
Authentication
Endpoints
Indexes
List Indexes
GET
Create Index
POST
Get Index
GET
Delete Index
DELETE
Update Index
PATCH
Swap Indexes
POST
Documents
Get Documents
GET
Add or update documents
PUT
Add or replace documents
POST
Delete all documents
DELETE
Get Documents
POST
Delete documents
POST
Delete documents
POST
Get one document
GET
Delete one document
DELETE
Search
Search
GET
Search
POST
Facet Search
POST
Multi Search
POST
Tasks
Get all tasks
GET
Delete tasks
DELETE
Get a task
GET
Cancel tasks
POST
Keys
Get API Keys
GET
Create an API Key
POST
Get an API key from its uid or key field.
GET
Delete an API key specified by its uid or key field.
DELETE
Update an API key specified by its uid or key field.
PATCH
Settings
Get settings
GET
Reset settings
DELETE
Update settings
PATCH
Get synonyms
GET
Update synonyms
PUT
Reset synonyms
DELETE
Get sortable attributes
GET
Update sortable attributes
PUT
Reset sortable attributes
DELETE
Get stop-words
GET
Update stop-words
PUT
Reset stop-words
DELETE
Get ranking rules
GET
Update ranking rules
PUT
Reset ranking rules
DELETE
Get typo tolerance configuration
GET
Reset typo tolerance settings to the default configuration
DELETE
Update typo tolerance settings
PATCH
Get pagination configuration
GET
Reset pagination settings to the default configuration
DELETE
Update pagination settings
PATCH
Get faceting configuration
GET
Reset faceting settings to the default configuration
DELETE
Update faceting settings
PATCH
Get Filterable Attributes
GET
Update Filterable Attributes
PUT
Reset Filterable Attributes
DELETE
Get distinct attribute
GET
Update distinct attribute
PUT
Reset distinct attribute
DELETE
Get searchable attributes
GET
Update searchable attributes
PUT
Reset searchable attributes
DELETE
Get displayed attributes
GET
Update displayed attributes
PUT
Reset displayed attributes
DELETE
Stats
Get stat of an index
GET
Get stats of all indexes
GET
(EXPERIMENTAL) Get prometheus format metrics for observability and monitoring
GET
Health
Get health
GET
Version
Get version of Meilisearch
GET
Dumps
Create a Dump
POST
Snapshots
Create a Snapshot
POST
Experimental
(EXPERIMENTAL) Get the status of runtime experimental features
GET
(EXPERIMENTAL) Set the status of runtime experimental features
PATCH
Dismiss highlight
Show more
Version
Current version of Meilisearch.