Meilisearch

https://www.meilisearch.com/docs
Admin
Meilisearch is a fast, relevant, and typo-tolerant search engine that provides AI-powered search,...
Tokens:1,009,820
Snippets:9,235
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Full example

Source: https://www.meilisearch.com/docs/getting_started/sdks/javascript

Complete example combining client setup, adding documents, and searching. Demonstrates the full workflow from import to main execution.

```javascript
import { Meilisearch } from 'meilisearch'

const client = new Meilisearch({
  host: process.env.MEILISEARCH_URL,
  apiKey: process.env.MEILISEARCH_KEY
})

async function main() {
  // Add documents
  const movies = [
    { id: 1, title: 'The Matrix', genres: ['Action', 'Sci-Fi'], year: 1999 },
    { id: 2, title: 'Inception', genres: ['Action', 'Thriller'], year: 2010 },
    { id: 3, title: 'Interstellar', genres: ['Drama', 'Sci-Fi'], year: 2014 }
  ]

  const task = await client.index('movies').addDocuments(movies)
  await client.waitForTask(task.taskUid)

  // Search
  const results = await client.index('movies').search('inter')
  console.log(results.hits)
}

main()
```

--------------------------------

### Install dependencies with dart pub get or flutter pub get

Source: https://www.meilisearch.com/docs/getting_started/sdks/dart

Runs the package manager to install the dependencies. Use 'dart pub get' for Dart projects and 'flutter pub get' for Flutter projects.

```bash
dart pub get
# or for Flutter
flutter pub get

```

--------------------------------

### Install and launch Meilisearch with cURL

Source: https://www.meilisearch.com/docs/resources/self_hosting/getting_started/install_locally

Downloads the latest stable release of Meilisearch with cURL and launches the server. Use this snippet to start Meilisearch locally after downloading it.

```bash
# Install Meilisearch
curl -L https://install.meilisearch.com | sh

```

```bash
./meilisearch
```

--------------------------------

### Add documents with the PHP SDK

Source: https://www.meilisearch.com/docs/getting_started/sdks/php

Creates a movies array with id, title, genres, and year fields. This example is part of the PHP SDK getting started guide and is used to add documents to a Meilisearch index.

```php
$movies = [
    ['id' => 1, 'title' => 'The Matrix', 'genres' => ['Action', 'Sci-Fi'], 'year' => 1999],
    ['id' => 2, 'title' => 'Inception', 'genres' => ['Action', 'Thriller'], 'year' => 2010],
];
```

--------------------------------

### Full example: add documents and search

Source: https://www.meilisearch.com/docs/getting_started/sdks/ruby

Complete example combining connection, adding documents, waiting for indexing, and searching.

```ruby
require 'meilisearch'

client = MeiliSearch::Client.new(
  ENV['MEILISEARCH_URL'],
  ENV['MEILISEARCH_KEY']
)

# Add documents
movies = [
  { id: 1, title: 'The Matrix', genres: ['Action', 'Sci-Fi'], year: 1999 },
  { id: 2, title: 'Inception', genres: ['Action', 'Thriller'], year: 2010 },
  { id: 3, title: 'Interstellar', genres: ['Drama', 'Sci-Fi'], year: 2014 }
]

task = client.index('movies').add_documents(movies)
client.wait_for_task(task['taskUid'])

# Search
results = client.index('movies').search('inter')
puts results['hits']

```

--------------------------------

### GET /network response example

Source: https://www.meilisearch.com/docs/reference/api/experimental-features/configure-network-topology

Example JSON response from the GET /network endpoint, showing the self node and remote nodes with their URLs and API keys.

```json
{
  "self": "ms-0",
  "remotes": {
    "ms-0": {
      "url": "http://localhost:7700",
      "searchApiKey": null,
      "writeApiKey": null
    },
    "ms-1": {
      "url": "http://localhost:7701",
      "searchApiKey": "foo",
      "writeApiKey": "bar"
    },
    "ms-2": {
      "url": "http://localhost:7702",
      "searchApiKey": "bar",
      "writeApiKey": "foo"
    }
  }
}
```

--------------------------------

### Full example: Connect, add documents, and search

Source: https://www.meilisearch.com/docs/getting_started/sdks/java

Complete example that connects, adds documents as JSON strings, waits for indexing, and performs a search. Throws Exception on errors.

```java
import com.meilisearch.sdk.*;
import com.meilisearch.sdk.model.*;
import com.google.gson.Gson;

public class Main {
    public static void main(String[] args) throws Exception {
        // Connect
        Client client = new Client(new Config(
            System.getenv("MEILISEARCH_URL"),
            System.getenv("MEILISEARCH_KEY")
        ));

        // Add documents
        String documents = "[" +
            "{\"id\": 1, \"title\": \"The Matrix\", \"year\": 1999}," +
            "{\"id\": 2, \"title\": \"Inception\", \"year\": 2010}," +
            "{\"id\": 3, \"title\": \"Interstellar\", \"year\": 2014}" +
        "]";

        Index index = client.index("movies");
        TaskInfo task = index.addDocuments(documents);
        client.waitForTask(task.getTaskUid());

        // Search
        SearchResult results = index.search("inter");
        System.out.println(results.getHits());
    }
}
```

--------------------------------

### Get filterableAttributes for an index

Source: https://www.meilisearch.com/docs/reference/api/settings/get-filterableattributes

Retrieve the current filterableAttributes setting for the 'movies' index using the REST API or one of the Meilisearch SDKs. The cURL example uses GET with an Authorization header; SDK examples call the corresponding method on the client. The Java example shows both the granular (v1.14+) and legacy APIs.

```bash
curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes' \
  -H 'Authorization: Bearer API_KEY'
```

```javascript
client.index('movies').getFilterableAttributes()
```

```php
$client->index('movies')->getFilterableAttributes();
```

```python
client.index('movies').get_filterable_attributes()
```

```java
// Granular filterable attributes API (v1.14+)
client.index("movies").getGranularFilterableAttributesSettings();
// Legacy String[] API
client.index("movies").getFilterableAttributesSettings();
```

```ruby
client.index('movies').filterable_attributes
```

```go
client.Index("movies").GetFilterableAttributes()
```

```csharp
IEnumerable<FilterableAttribute> attributes = await client.Index("movies").GetFilterableAttributesAsync();
```

```rust
let filterable_attributes: Vec<String> = client
  .index("movies")
  .get_filterable_attributes()
  .await
  .unwrap();
```

```dart
await client.index('movies').getFilterableAttributes();
```

```swift
client.index("movies").getFilterableAttributes { (result) in
    switch result {
    case .success(let attributes):
        print(attributes)
    case .failure(let error):
        print(error)
    }
}
```

--------------------------------

### Quick example: index.html with instant-meilisearch and InstantSearch

Source: https://www.meilisearch.com/docs/getting_started/instant_meilisearch/javascript

Complete HTML file that sets up a search interface with a search box and hits widget. It loads instant-meilisearch and InstantSearch from CDN, initializes the search client with a public demo instance, and adds widgets for search and results. Open this file in a browser to see a working search interface.

```html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@meilisearch/instant-meilisearch/templates/basic_search.css" />
  </head>
  <body>
    <div class="wrapper">
      <div id="searchbox"></div>
      <div id="hits"></div>
    </div>

    <script src="https://cdn.jsdelivr.net/npm/@meilisearch/instant-meilisearch/dist/instant-meilisearch.umd.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4"></script>

    <script>
      const { searchClient } = instantMeiliSearch(
        'https://ms-adf78ae33284-106.lon.meilisearch.io',
        'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303'
      );

      const search = instantsearch({
        indexName: 'steam-videogames',
        searchClient
      });

      search.addWidgets([
        instantsearch.widgets.searchBox({ container: '#searchbox' }),
        instantsearch.widgets.hits({
          container: '#hits',
          templates: {
            item: (hit, { html, components }) => html`
              <div>
                <h2>${components.Highlight({ hit, attribute: 'name' })}</h2>
                <p>${hit.description}</p>
              </div>
            `
          }
        })
      ]);

      search.start();
    </script>
  </body>
</html>
```

--------------------------------

### Java Unirest GET experimental-features

Source: https://www.meilisearch.com/docs/reference/api/experimental-features/list-experimental-features

Java example using Unirest to GET the experimental-features endpoint with a bearer token.

```java
HttpResponse<String> response = Unirest.get("http://localhost:7700/experimental-features")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Full Meilisearch Go example

Source: https://www.meilisearch.com/docs/getting_started/sdks/go

Complete example combining connection, adding documents, waiting for indexing, and searching. Requires environment variables MEILISEARCH_URL and MEILISEARCH_KEY.

```go
package main

import (
    "fmt"
    "os"
    "github.com/meilisearch/meilisearch-go"
)

type Movie struct {
    ID     int      `json:"id"`
    Title  string   `json:"title"`
    Genres []string `json:"genres"`
    Year   int      `json:"year"`
}

func main() {
    client := meilisearch.New(
        os.Getenv("MEILISEARCH_URL"),
        meilisearch.WithAPIKey(os.Getenv("MEILISEARCH_KEY")),
    )

    // Add documents
    movies := []Movie{
        {ID: 1, Title: "The Matrix", Genres: []string{"Action", "Sci-Fi"}, Year: 1999},
        {ID: 2, Title: "Inception", Genres: []string{"Action", "Thriller"}, Year: 2010},
        {ID: 3, Title: "Interstellar", Genres: []string{"Drama", "Sci-Fi"}, Year: 2014},
    }

    task, _ := client.Index("movies").AddDocuments(movies)
    client.WaitForTask(task.TaskUID)

    // Search
    results, _ := client.Index("movies").Search("inter", nil)
    fmt.Println(results.Hits)
}

```

--------------------------------

### Initialize project (Python)

Source: https://www.meilisearch.com/docs/resources/migration/mongodb_migration

Creates a new directory and creates a script.py file.

```bash
mkdir mongodb-meilisearch-migration
cd mongodb-meilisearch-migration
touch script.py

```

--------------------------------

### Get settings for the 'movies' index

Source: https://www.meilisearch.com/docs/reference/api/settings/get-ranking-rules

Retrieve the settings of the 'movies' index using the Meilisearch API. The cURL example uses the GET endpoint with an Authorization header. The SDK examples show the equivalent method calls in various languages.

```bash
curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings' \
  -H 'Authorization: Bearer API_KEY'
```

```javascript
client.index('movies').getSettings()
```

```php
$client->index('movies')->getSettings();
```

```python
client.index('movies').get_settings()
```

```java
client.index("movies").getSettings();
```

```ruby
client.index('movies').settings
```

```go
client.Index("movies").GetSettings()
```

```csharp
await client.Index("movies").GetSettingsAsync();
```

```rust
let settings: Settings = client
  .index("movies")
  .get_settings()
  .await
  .unwrap();
```

```javascript
await client.index('movies').getSettings();
```

```swift
client.index("movies").getSettings { (result) in
    switch result {
    case .success(let setting):
        print(setting)
    case .failure(let error):
        print(error)
    }
}
```

--------------------------------

### Dockerfile to Install Kestra Plugins

Source: https://www.meilisearch.com/docs/getting_started/integrations/kestra/kafka

Extends the Kestra image and installs the Meilisearch, Kafka, and transform-json plugins. Required for the flows in this guide.

```dockerfile
FROM kestra/kestra:latest
RUN /app/kestra plugins install \
      io.kestra.plugin:plugin-meilisearch:LATEST \
      io.kestra.plugin:plugin-kafka:LATEST \
      io.kestra.plugin:plugin-transform-json:LATEST
```

--------------------------------

### Create Strapi back-end with quickstart

Source: https://www.meilisearch.com/docs/getting_started/frameworks/strapi

Run this command to create a Strapi app in a new directory called 'back' and open the admin dashboard. Requires Node.js >=18.0.0 <=20.x.x and npm >=6.0.0.

```bash
npx create-strapi-app@latest back --quickstart

```

--------------------------------

### Initialize project (Ruby)

Source: https://www.meilisearch.com/docs/resources/migration/mongodb_migration

Creates a new directory and creates a script.rb file.

```bash
mkdir mongodb-meilisearch-migration
cd mongodb-meilisearch-migration
touch script.rb

```

--------------------------------

### Response examples for get embedders

Source: https://www.meilisearch.com/docs/reference/api/settings/get-embedders

Example responses for the get embedders request: a successful empty response, a 401 error for missing authorization, and a 404 error for a non-existent index. The 401 response includes error code 'missing_authorization_header' and the 404 includes 'index_not_found'.

```json
{}
```

```json
{
  "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"
}
```

```json
{
  "message": "Index `movies` not found.",
  "code": "index_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors#index_not_found"
}
```

--------------------------------

### Full example

Source: https://www.meilisearch.com/docs/getting_started/sdks/dotnet

A complete example that connects to Meilisearch, adds documents, waits for indexing, and performs a search.

```csharp
using Meilisearch;

var client = new MeilisearchClient(
    Environment.GetEnvironmentVariable("MEILISEARCH_URL"),
    Environment.GetEnvironmentVariable("MEILISEARCH_KEY")
);

// Add documents
var movies = new[]
{
    new { Id = 1, Title = "The Matrix", Year = 1999 },
    new { Id = 2, Title = "Inception", Year = 2010 },
    new { Id = 3, Title = "Interstellar", Year = 2014 }
};

var index = client.Index("movies");
var task = await index.AddDocumentsAsync(movies);
await client.WaitForTaskAsync(task.TaskUid);

// Search
var results = await index.SearchAsync<dynamic>("inter");
foreach (var hit in results.Hits)
{
    Console.WriteLine(hit);
}

```

--------------------------------

### GET document example

Source: https://www.meilisearch.com/docs/reference/api/documents/get-document

Fetches a document's JSON from the sample URL. This example assumes a local server and that the index and document exist.

```curl
curl --request GET \
  --url 'http://localhost:7700/indexes/movies/documents/25684'
```

```shell
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
```

--------------------------------

### System prompt with positive examples for product support assistant

Source: https://www.meilisearch.com/docs/capabilities/agentic_search/advanced/reduce_hallucination

Use this system prompt to provide the model with 2-3 examples of correct behavior, demonstrating how to answer questions using only search results and cite sources. The examples cover answering with available information, admitting when information is not found, and comparing products with available data.

```text
You are a product support assistant. Answer questions using only the
search results provided. Here are examples of how to respond:

Example 1:
User: "What is the battery life of the X100?"
Search results contain: "The X100 features a 4500mAh battery with
up to 12 hours of screen-on time."
Good answer: "The X100 has a 4500mAh battery that provides up to
12 hours of screen-on time. [Source: X100 product page]"

Example 2:
User: "Does the X100 support wireless charging?"
Search results contain: Information about X100 battery and display,
but nothing about wireless charging.
Good answer: "I could not find information about wireless charging
for the X100 in our documentation. You may want to check the full
specifications page or contact our support team."

Example 3:
User: "Compare the X100 and the Y200 battery life."
Search results contain: "X100: 4500mAh, 12h screen-on time" and
"Y200: 5000mAh battery"
Good answer: "The X100 has a 4500mAh battery with up to 12 hours
of screen-on time. The Y200 has a larger 5000mAh battery, but I
could not find its screen-on time in the available documents.
[Sources: X100 product page, Y200 product page]"

Now answer the user's question following this same pattern.
```

--------------------------------

### Initialize project (Python)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Creates a new directory and an empty Python script for the migration.

```bash
mkdir qdrant-meilisearch-migration
cd qdrant-meilisearch-migration
touch script.py

```

--------------------------------

### Install Kestra Meilisearch and MongoDB plugins

Source: https://www.meilisearch.com/docs/getting_started/integrations/kestra/mongodb

Dockerfile that installs the Meilisearch and MongoDB plugins into the Kestra image. Required to use the flows in this guide.

```dockerfile
FROM kestra/kestra:latest
RUN /app/kestra plugins install \
      io.kestra.plugin:plugin-meilisearch:LATEST \
      io.kestra.plugin:plugin-mongodb:LATEST

```

--------------------------------

### Create Qdrant client (Python)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Initializes a Qdrant client with your host URL and optional API key. Replace QDRANT_URL with your instance URL.

```python
from qdrant_client import QdrantClient

qdrant_client = QdrantClient(
    url="QDRANT_URL",
    # api_key="QDRANT_API_KEY",  # if authentication is enabled
)

```

--------------------------------

### Java (Unirest): Get embedders settings

Source: https://www.meilisearch.com/docs/reference/api/settings/get-embedders

Use this Java example with Unirest to GET the embedders settings. Replace {index_uid} and <token> with actual values.

```Java
HttpResponse<String> response = Unirest.get("http://localhost:7700/indexes/{index_uid}/settings/embedders")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Get webhook with PHP cURL

Source: https://www.meilisearch.com/docs/reference/api/webhooks/get-webhook

PHP example using cURL to send a GET request to the /webhooks/{uuid} endpoint. Requires a valid token in the Authorization header.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/webhooks/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Initialize project (Ruby)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Creates a new directory and an empty Ruby script for the migration.

```bash
mkdir qdrant-meilisearch-migration
cd qdrant-meilisearch-migration
touch script.rb

```

--------------------------------

### Initialize project (JavaScript)

Source: https://www.meilisearch.com/docs/resources/migration/mongodb_migration

Creates a new directory and initializes a Node.js project with npm, then creates a script.js file.

```bash
mkdir mongodb-meilisearch-migration
cd mongodb-meilisearch-migration
npm init -y
touch script.js

```

--------------------------------

### Go: Get embedders settings

Source: https://www.meilisearch.com/docs/reference/api/settings/get-embedders

Use this Go example with net/http to GET the embedders settings. Replace {index_uid} and <token> with actual values. Prints the response body.

```Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:7700/indexes/{index_uid}/settings/embedders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Create Qdrant client (Ruby)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Initializes a Qdrant client with your host URL and optional API key. Replace QDRANT_URL with your instance URL.

```ruby
require 'qdrant'

qdrant_client = Qdrant::Client.new(
  url: 'QDRANT_URL'
  # api_key: 'QDRANT_API_KEY'  # if authentication is enabled
)

```

--------------------------------

### Full-text search with Contact::search()->get()

Source: https://www.meilisearch.com/docs/getting_started/frameworks/laravel

Call the search method on a model and retrieve matching Eloquent models with get. This example searches for 'Marie' in the Contact model.

```php
use App\Models\Contact;

$contacts = Contact::search('Marie')->get();

```

--------------------------------

### PHP (cURL): Get embedders settings

Source: https://www.meilisearch.com/docs/reference/api/settings/get-embedders

Use this PHP example with cURL to GET the embedders settings. Replace {index_uid} and <token> with actual values. Prints response or error.

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/indexes/{index_uid}/settings/embedders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Install React InstantSearch and Meilisearch libraries

Source: https://www.meilisearch.com/docs/getting_started/instant_meilisearch/react

Install the required packages: react-instantsearch, @meilisearch/instant-meilisearch, and instantsearch.css.

```bash
npm install react-instantsearch @meilisearch/instant-meilisearch instantsearch.css

```

--------------------------------

### Get index stats using Meilisearch SDKs

Source: https://www.meilisearch.com/docs/reference/api/indexes/get-stats-of-index

SDK examples to retrieve index statistics for 'movies'. The Python example includes optional parameters for internal database sizes and human-readable format. The Swift example handles both success and failure cases.

```javascript
client.index('movies').getStats()
```

```php
$client->index('movies')->stats();
```

```python
client.index('movies').get_stats(show_internal_database_sizes=True, size_format='human')
```

```java
client.index("movies").getStats();
```

```ruby
client.index('movies').stats
```

```go
client.Index("movies").GetStats(nil)
```

```csharp
await client.Index("movies").GetStatsAsync();
```

```rust
let stats: IndexStats = client
  .index("movies")
  .get_stats()
  .await
  .unwrap();
```

```dart
await client.index('movies').getStats();
```

```swift
client.index("movies").stats { (result) in
    switch result {
    case .success(let stats):
        print(stats)
    case .failure(let error):
        print(error)
    }
}
```

--------------------------------

### Create Qdrant client (JavaScript)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Initializes a Qdrant client with your host URL and optional API key. Replace QDRANT_URL with your instance URL.

```javascript
const { QdrantClient } = require("@qdrant/js-client-rest");

const qdrantClient = new QdrantClient({
  url: "QDRANT_URL",
  // apiKey: "QDRANT_API_KEY", // if authentication is enabled
});

```

--------------------------------

### Get webhook with Ruby Net::HTTP

Source: https://www.meilisearch.com/docs/reference/api/webhooks/get-webhook

Ruby example using Net::HTTP to send a GET request to the /webhooks/{uuid} endpoint. Requires a valid token in the Authorization header.

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:7700/webhooks/{uuid}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Start the development server

Source: https://www.meilisearch.com/docs/getting_started/instant_meilisearch/react

Run the Vite development server to start the app and test the search functionality.

```bash
npm run dev

```

--------------------------------

### Books dataset example document

Source: https://www.meilisearch.com/docs/capabilities/filtering_sorting_faceting/how_to/filter_with_facets

Example document from the books dataset used in the guide. It contains fields such as id, title, genres, publisher, language, author, description, format, and rating.

```json
{
  "id": 5,
  "title": "Hard Times",
  "genres": ["Classics","Fiction", "Victorian", "Literature"],
  "publisher": "Penguin Classics",
  "language": "English",
  "author": "Charles Dickens",
  "description": "Hard Times is a novel of social […] ",
  "format": "Hardcover",
  "rating": 3
}
```

--------------------------------

### Initialize project in Ruby

Source: https://www.meilisearch.com/docs/resources/migration/elasticsearch_migration

Creates the project directory and an empty Ruby script for the migration.

```bash
mkdir elastic-meilisearch-migration
cd elastic-meilisearch-migration
touch script.rb

```

--------------------------------

### GET route sort parameter example

Source: https://www.meilisearch.com/docs/capabilities/filtering_sorting_faceting/how_to/sort_results

Shows the `sort` parameter format for the GET route, which expects a comma-separated string. Each attribute must be followed by a colon and the sorting order (`asc` or `desc`).

```text
sort="price:desc,author:asc"

```

--------------------------------

### Initialize project (JavaScript)

Source: https://www.meilisearch.com/docs/resources/migration/qdrant_migration

Creates a new directory and initializes a Node.js project for the migration script.

```bash
mkdir qdrant-meilisearch-migration
cd qdrant-meilisearch-migration
npm init -y
touch script.js

```

--------------------------------

### Get foreignKeys setting with cURL and SDKs

Source: https://www.meilisearch.com/docs/reference/api/settings/get-foreignkeys

Retrieve the current foreignKeys setting for an index. The cURL example uses the MEILISEARCH_URL and API_KEY placeholders; SDK examples use the client's index method. The PHP, Java, and Ruby examples use localhost:7700 and a token placeholder.

```bash
curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/foreign-keys' \
  -H 'Authorization: Bearer API_KEY'
```

```javascript
client.index('books').getForeignKeys()
```

```python
client.index('books').get_foreign_keys()
```

```csharp
client.Index("books").GetForeignKeys()
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/indexes/{index_uid}/settings/foreign-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```java
HttpResponse<String> response = Unirest.get("http://localhost:7700/indexes/{index_uid}/settings/foreign-keys")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:7700/indexes/{index_uid}/settings/foreign-keys")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Initialize Supabase Meilisearch migration project (Python)

Source: https://www.meilisearch.com/docs/resources/migration/supabase_migration

Create a directory and placeholder Python script for the migration.

```bash
mkdir supabase-meilisearch-migration
cd supabase-meilisearch-migration
touch script.py

```

--------------------------------

### JavaScript (fetch): Get embedders settings

Source: https://www.meilisearch.com/docs/reference/api/settings/get-embedders

Use this Node.js fetch API example to GET the embedders settings. Replace {index_uid} and <token> with your index UID and API key. Requires the fetch API.

```JavaScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:7700/indexes/{index_uid}/settings/embedders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Initialize project in Python

Source: https://www.meilisearch.com/docs/resources/migration/elasticsearch_migration

Creates the project directory and an empty Python script for the migration.

```bash
mkdir elastic-meilisearch-migration
cd elastic-meilisearch-migration
touch script.py

```

--------------------------------

### Initialize Supabase Meilisearch migration project (JavaScript)

Source: https://www.meilisearch.com/docs/resources/migration/supabase_migration

Create a directory and initialize a Node.js project for the migration script.

```bash
mkdir supabase-meilisearch-migration
cd supabase-meilisearch-migration
npm init -y
touch script.js

```

--------------------------------

### Successful response for get keys

Source: https://www.meilisearch.com/docs/reference/api/keys

Example 200 response containing a list of keys with pagination details.

```json
{
  "results": [
    {
      "uid": "01b4bc42-eb33-4041-b481-254d00cce834",
      "key": "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4",
      "name": "An API Key",
      "description": null,
      "actions": [
        "documents.add"
      ],
      "indexes": [
        "movies"
      ],
      "expiresAt": "2022-11-12T10:00:00Z",
      "createdAt": "2021-11-12T10:00:00Z",
      "updatedAt": "2021-11-12T10:00:00Z"
    }
  ],
  "limit": 20,
  "offset": 0,
  "total": 1
}
```

--------------------------------

### Install Nginx

Source: https://www.meilisearch.com/docs/resources/self_hosting/deployment/gcp

Installs the Nginx web server using apt.

```bash
sudo apt install nginx -y

```

--------------------------------

### Get distinctAttribute via cURL and SDKs

Source: https://www.meilisearch.com/docs/reference/api/settings/get-distinctattribute

Get the current distinct attribute value for the 'shoes' index. All SDKs return the distinct attribute string. The Swift example includes a result handler with success and failure cases.

```shell
curl \
  -X GET 'MEILISEARCH_URL/indexes/shoes/settings/distinct-attribute' \
  -H 'Authorization: Bearer API_KEY'

```

```javascript
client.index('shoes').getDistinctAttribute()

```

```php
$client->index('shoes')->getDistinctAttribute();

```

```python
client.index('shoes').get_distinct_attribute()

```

```java
client.index("shoes").getDistinctAttributeSettings();

```

```ruby
client.index('shoes').distinct_attribute

```

```go
client.Index("shoes").GetDistinctAttribute()

```

```csharp
string result = await client.Index("shoes").GetDistinctAttributeAsync();

```

```rust
let distinct_attribute: Option<String> = client
  .index("shoes")
  .get_distinct_attribute()
  .await
  .unwrap();

```

```typescript
await client.index('shoes').getDistinctAttribute();

```

```swift
client.index("shoes").getDistinctAttribute { (result) in
    switch result {
    case .success(let distinctAttribute):
        print(distinctAttribute)
    case .failure(let error):
        print(error)
    }
}

```

--------------------------------

### GET /indexes/{index_uid}

Source: https://www.meilisearch.com/docs/reference/api/indexes/get-index

This snippet documents the GET /indexes/{index_uid} endpoint, which retrieves information about a specific index. It includes the endpoint path, required path parameter, authorization header, request example, and response details.

```APIDOC
## GET /indexes/{index_uid}

### Description
Fetches information about a specific index, including its unique identifier, primary key, and creation and update timestamps.

### Method
GET

### Endpoint
`/indexes/{index_uid}`

### Parameters
#### Path Parameters
- **index_uid** (string) - Required - Unique identifier of the index.

#### Authorization
- **Authorization** (string, header) - Required - An API key is a token that you provide when making API calls. Include the API key in the `Authorization` header, for example: `-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'`.

### Request Example
```
curl \
  -X GET 'MEILISEARCH_URL/indexes/movies' \
  -H 'Authorization: Bearer API_KEY'
```

### Response
#### Success Response (200)
The index is returned. An index containing searchable documents.

- **uid** (string) - Required - Unique identifier for the index. Once created, it cannot be changed.
- **createdAt** (string<date-time>) - Required - Creation date of the index, represented in RFC 3339 format.
- **updatedAt** (string<date-time>) - Required - Latest date of index update, represented in RFC 3339 format.
- **primaryKey** (string | null) - Primary key of the index.

#### Response Example
```
{
  "uid": "movies",
  "primaryKey": "movie_id",
  "createdAt": "2019-11-20T09:40:33.711324Z",
  "updatedAt": "2019-11-20T09:40:33.711324Z"
}
```

#### Error Responses
- **401** - Missing or invalid authorization header. Example:
```
{
  "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"
}
```
- **404** - Index not found. Example:
```
{
  "message": "Index `movies` not found.",
  "code": "index_not_found",
  "type": "invalid_request",
  "link": "https://docs.meilisearch.com/errors#index_not_found"
}
```
```

--------------------------------

### Initialize Supabase Meilisearch migration project (Ruby)

Source: https://www.meilisearch.com/docs/resources/migration/supabase_migration

Create a directory and placeholder Ruby script for the migration.

```bash
mkdir supabase-meilisearch-migration
cd supabase-meilisearch-migration
touch script.rb

```

--------------------------------

### Build and develop Strapi app

Source: https://www.meilisearch.com/docs/getting_started/frameworks/strapi

After installing the plugin, rebuild the Strapi app and start it in development mode. This makes configuration easier.

```bash
npm run build
npm run develop

```

--------------------------------

### Enable and start Meilisearch service

Source: https://www.meilisearch.com/docs/resources/self_hosting/deployment/running_production

Enables the service to start at boot and immediately starts it.

```bash
systemctl enable meilisearch
systemctl start meilisearch

```

--------------------------------

### Java (Unirest): Get batch

Source: https://www.meilisearch.com/docs/reference/api/async-task-management/get-batch

Use this Java example with Unirest to retrieve a batch by its ID. Replace the token and URL as needed.

```java
HttpResponse<String> response = Unirest.get("http://localhost:7700/batches/{batch_id}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Initialize the Meilisearch search client

Source: https://www.meilisearch.com/docs/getting_started/instant_meilisearch/react

Import instantMeiliSearch and create a searchClient using the provided Meilisearch host and API key.

```javascript
import React from 'react';
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch';

const { searchClient } = instantMeiliSearch(
  'https://ms-adf78ae33284-106.lon.meilisearch.io',
  'a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303'
);

```

--------------------------------

### Install Nginx

Source: https://www.meilisearch.com/docs/resources/self_hosting/deployment/running_production

Installs the Nginx web server on the machine. This is the first step in setting up a reverse proxy for Meilisearch.

```bash
apt-get install nginx -y

```

--------------------------------

### Swift SDK: Get task by ID with completion handler

Source: https://www.meilisearch.com/docs/reference/api/async-task-management/get-task

Alternative Swift example using a completion handler to print the task or error.

```swift
client.getTask(taskUid: 1) { (result) in
      switch result {
      case .success(let task):
          print(task)
      case .failure(let error):
          print(error)
      }
  }
```

--------------------------------

### Install packages with npm

Source: https://www.meilisearch.com/docs/capabilities/agentic_search/getting_started

Install the AI SDK, OpenAI provider, and Meilisearch AI SDK.

```bash
npm install ai @ai-sdk/openai @meilisearch/ai-sdk
```
Tokens:
Raw