Search

MeiliSearch exposes 2 routes to perform searches:

• A POST route: this is the preferred route when using API authentication, as it allows preflight request (opens new window) caching and better performances.
• A GET route: the usage of this route is discouraged, unless you have good reason to do otherwise (specific caching abilities for example).

Other than the differences mentioned above, the two routes are strictly equivalent.

Search in an index with POST route

POST

/indexes/:index_uid/search

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 (opens new window) to be cached. Caching preflight requests improves considerably the speed of the search.

Path Variables

Body

filters accept a query string. You can find more about the filter syntax on our dedicated page.
cropLength is automatically rounded to match word boundaries.

Learn more about how to use the search parameters.

Response

Example

$ curl \
  'http://localhost:7700/indexes/movies/search' \
  --data '{ "q": "american ninja" }'

client.index('movies').search('American ninja')

client.index('movies').search('American ninja')

// Do a search
$searchResults = $client->index('movies')->search('american ninja');
// Get results in an Array using a getter
$hits = $searchResults->getHits();
// Get the decoded response of MeiliSearch, see response below
$response = $searchResults->getRaw();

index.search('american ninja')

client.Search("movies").Search(SearchRequest{
  Query: "American ninja",
})

let results: SearchResults<Movie> = movies
  .search()
  .with_query("American ninja")
  .execute()
  .await
  .unwrap();

Response: 200 Ok

{
  "hits": [
    {
      "id": "2770",
      "title": "American Pie 2",
      "poster": "https://image.tmdb.org/t/p/w1280/q4LNgUnRfltxzp3gf1MAGiK5LhV.jpg",
      "overview": "The whole gang are back and as close as ever. They decide to
      get even closer by spending the summer together at a beach house. They
      decide to hold the biggest...",
      "release_date": 997405200
    },
    {
      "id": "190859",
      "title": "American Sniper",
      "poster": "https://image.tmdb.org/t/p/w1280/svPHnYE7N5NAGO49dBmRhq0vDQ3.jpg",
      "overview": "U.S. Navy SEAL Chris Kyle takes his sole mission—protect his
      comrades—to heart and becomes one of the most lethal snipers in American
      history. His pinpoint accuracy not only saves countless lives but also
      makes him a prime...",
      "release_date": 1418256000
    },
    ...
  ],
  "offset": 0,
  "limit": 20,
  "nbHits": 976,
  "exhaustiveNbHits": false,
  "processingTimeMs": 35,
  "query": "american "
}

Search in an index with GET route

GET

/indexes/:index_uid/search

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.

Learn more about how the search works.

Path Variables

Query Parameters

filters accept a query string. You can find about the filter syntax on our dedicated page.
cropLength is automatically rounded to match word boundaries.

Learn more about how to use the search parameters.

Placeholder Search

When the q parameter is not specified, a placeholder search is run instead.

Response

Example

$ curl \
  'http://localhost:7700/indexes/movies/search' \
  --data '{ "q": "american ninja" }'

client.index('movies').search('American ninja')

client.index('movies').search('American ninja')

// Do a search
$searchResults = $client->index('movies')->search('american ninja');
// Get results in an Array using a getter
$hits = $searchResults->getHits();
// Get the decoded response of MeiliSearch, see response below
$response = $searchResults->getRaw();

index.search('american ninja')

client.Search("movies").Search(SearchRequest{
  Query: "American ninja",
})

let results: SearchResults<Movie> = movies
  .search()
  .with_query("American ninja")
  .execute()
  .await
  .unwrap();

Response: 200 Ok

{
  "hits": [
    {
      "id": "2770",
      "title": "American Pie 2",
      "poster": "https://image.tmdb.org/t/p/w1280/q4LNgUnRfltxzp3gf1MAGiK5LhV.jpg",
      "overview": "The whole gang are back and as close as ever. They decide to
      get even closer by spending the summer together at a beach house. They
      decide to hold the biggest...",
      "release_date": 997405200
    },
    {
      "id": "190859",
      "title": "American Sniper",
      "poster": "https://image.tmdb.org/t/p/w1280/svPHnYE7N5NAGO49dBmRhq0vDQ3.jpg",
      "overview": "U.S. Navy SEAL Chris Kyle takes his sole mission—protect his
      comrades—to heart and becomes one of the most lethal snipers in American
      history. His pinpoint accuracy not only saves countless lives but also
      makes him a prime...",
      "release_date": 1418256000
    },
    ...
  ],
  "offset": 0,
  "limit": 20,
  "nbHits": 976,
  "exhaustiveNbHits": false,
  "processingTimeMs": 35,
  "query": "american "
}