API reference

API reference
# API reference

Welcome to the Meilisearch API documentation. If you are new to Meilisearch, check out our quick start guide!

Meilisearch is a RESTful API. This page describes the general behavior of the API.

You can download the Meilisearch OpenAPI specifications at:

# Document conventions

This API documentation uses the following conventions:

Curly braces ( {} ) in API routes represent path parameters, e.g., GET /indexes/{index_uid}

) in API routes represent path parameters, e.g., GET Required fields are marked by an asterisk ( * )

) Placeholder text is in uppercase characters with underscore delimiters, e.g., MASTER_KEY

By providing Meilisearch with a master key at launch, you protect your instance from unauthorized requests. From then on, you must include the Authorization header along with a valid API key to access protected routes (all routes except /health .

curl \ -X GET 'http://localhost:7700/keys' \ -H 'Authorization: Bearer MASTER_KEY' const client = new MeiliSearch ( { host : 'http://localhost:7700' , apiKey : 'masterKey' } ) client . getKeys ( ) client = Client ( 'http://localhost:7700' , 'masterKey' ) client . get_keys ( ) $client = new Client ( 'http://localhost:7700' , 'masterKey' ) ; $client -> getKeys ( ) ; Client client = new Client ( new Config ( "http://127.0.0.1:7700" , "masterKey" ) ) ; client . getKeys ( ) ; client = MeiliSearch :: Client . new ( 'http://localhost:7700' , 'masterKey' ) client . keys client := meilisearch . NewClient ( meilisearch . ClientConfig { Host : "http://localhost:7700" , APIKey : "masterKey" , } ) client . GetKeys ( nil ) ; MeilisearchClient client = new MeilisearchClient ( "http://localhost:7700" , "masterKey" ) ; var keys = await client . GetKeysAsync ( ) ; let client = Client :: new ( "http://localhost:7700" , "masterKey" ) ; let keys = client . get_keys ( ) . await . unwrap ( ) ; cli!
ent = try MeiliSearch ( host : "http://localhost:7700" , apiKey : "masterKey" ) client . getKeys { result in switch result { case . success ( let keys ) : print ( keys ) case . failure ( let error ) : print ( error ) } } var client = MeiliSearchClient ( 'http://localhost:7700' , 'masterKey' ) ; await client . getKeys ( ) ;

The /keys route can only be accessed using the master key. For security reasons, we recommend using regular API keys for all other routes.

NOTE v0.24 and below use the X-MEILI-API-KEY: apiKey authorization header:

curl \ -X GET 'http://localhost:7700/version' \ -H 'X-Meili-API-Key: API_KEY'

To learn more about keys and security, refer to our dedicated guide.

Meilisearch paginates all GET routes that return multiple resources, e.g., GET /indexes , GET /documents , GET /keys , etc. This allows you to work with manageable chunks of data. All these routes return 20 results per page, but you can configure it using the limit query parameter. You can move between pages using offset .

All paginated responses contain the following fields:

Name Type Description offset Integer Number of resources skipped limit Integer Number of resources returned total Integer Total number of resources

Since the /tasks endpoint uses a different type of pagination, the response contains different fields. You can read more about it in the tasks API reference.

Parameters are options you can pass to an API endpoint to modify its response. There are three main types of parameters in Meilisearch's API: request body parameters, path parameters, and query parameters.

# Request body parameters

These parameters are mandatory parts of POST, PUT, and PATCH requests. They accept a wide variety of values and data types depending on the resource you're modifying. You must add these parameters to your request's data payload.

# Path parameters

These are parameters you pass to the API in the endpoint's path. They are used to identify a resource uniquely. You can have multiple path parameters, e.g., /indexes/{index_uid}/documents/{document_id} .

If an endpoint does not take any path parameters, this section is not present in that endpoint's documentation.

# Query parameters

These optional parameters are a sequence of key-value pairs and appear after the question mark ( ? ) in the endpoint. You can list multiple query parameters by separating them with an ampersand ( & ). The order of query parameters does not matter. They are mostly used with GET endpoints.

If an endpoint does not take any query parameters, this section is not present in that endpoint's documentation.

# Content type

Any API request with a payload ( --data-binary ) requires a Content-Type header. Content type headers indicate the media type of the resource, helping the client process the response body correctly.

Meilisearch currently supports the following formats:

Content-Type: application/json for JSON

for JSON Content-Type: application/x-ndjson for NDJSON

for NDJSON Content-Type: text/csv for CSV

Only the add documents and update documents endpoints accept NDJSON and CSV. For all others, use Content-Type: application/json .

# Request body

The request body is data sent to the API. It is used with PUT, POST, and PATCH methods to create or update a resource. You must provide request bodies in JSON.

# Response body

Meilisearch is an asynchronous API. This means that in response to most write requests, you will receive a summarized version of the task object:

{ "taskUid" : 1 , "indexUid" : "movies" , "status" : "enqueued" , "type" : "indexUpdate" , "enqueuedAt" : "2021-08-11T09:25:53.000000Z" }

You can use this taskUid to get more details on the status of the task.

See more information about asynchronous operations.

# Data types

The Meilisearch API supports JSON data types (opens new window).