Meilisearch
Index rows in Meilisearch and run typo-tolerant searches and filtered finds, with index settings. Typical uses: give an application instant search, search a catalogue.
meili pingmeili collection_createmeili collection_createmeili collectionsmeili insertmeili insertmeili taskmeili taskmeili infomeili settings_updatemeili settings_updatemeili settingsmeili collection_infomeili putmeili putmeili searchmeili searchmeili searchmeili findmeili findmeili countmeili countmeili updatemeili updatemeili update_rowsmeili update_rowsmeili getmeili deletemeili deletemeili delete_wheremeili delete_wheremeili requestmeili requestmeili collection_dropmeili collection_drop
meili ping <config>
Description
Test the server (no key needed): {ok, status}
Test the server (no key needed): {ok, status}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
meili ping "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}"
mentdb
{"ok": true, "status": "available"}
meili collection_create <config> <name>
Description
Create an index (the primary key is guessed from the first documents: a field ending with id). Returns {created, task_uid}
Create an index (the primary key is guessed from the first documents: a field ending with id). Returns {created, task_uid}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
admin
meili collection_create "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies"
mentdb
{"created": "movies", "task_uid": 0}
meili collection_create <config> <name> <options_json>
Description
Create an index with options: primary_key, wait, wait_timeout_ms
Create an index with options: primary_key, wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
options_json: The options - String - required
admin
meili collection_create "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"primary_key\": \"id\"}"
mentdb
{"created": "books", "task_uid": 1}
meili collections <config>
Description
The names (uids) of the indexes
The names (uids) of the indexes
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
meili collections "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}"
mentdb
["books", "movies"]
meili insert <config> <index> <rows_json>
Description
Insert or replace documents from MQL rows, by batches of 10000. Returns {inserted, errors, tasks}
Insert or replace documents from MQL rows, by batches of 10000. Returns {inserted, errors, tasks}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
admin
meili insert "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "[{\"id\": 1, \"title\": \"Les Misérables\", \"author\": \"Hugo\", \"year\": 1862, \"price\": 12.5}, {\"id\": 2, \"title\": \"Notre-Dame de Paris\", \"author\": \"Hugo\", \"year\": 1831, \"price\": 9.9}, {\"id\": 3, \"title\": \"Madame Bovary\", \"author\": \"Flaubert\", \"year\": 1857, \"price\": 7.2}, {\"id\": 4, \"title\": \"Germinal\", \"author\": \"Zola\", \"year\": 1885, \"price\": 8.4}]"
mentdb
{"inserted": 4, "errors": [], "tasks": [2]}
meili insert <config> <index> <rows_json> <options_json>
Description
Insert with options: primary_key, batch_size (10000), wait (true), wait_timeout_ms (120000 for all the batches)
Insert with options: primary_key, batch_size (10000), wait (true), wait_timeout_ms (120000 for all the batches)
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
admin
meili insert "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies" "[{\"movie_id\": 1, \"title\": \"Amélie\"}]" "{\"primary_key\": \"movie_id\", \"wait\": false}"
mentdb
{"status": "enqueued", "tasks": [3]}
meili task <config> <task_uid>
Description
A task, awaited by default (an ended task is returned as is, even failed): {task_uid, index_uid, status, type, error, details, duration, enqueued_at, finished_at}
A task, awaited by default (an ended task is returned as is, even failed): {task_uid, index_uid, status, type, error, details, duration, enqueued_at, finished_at}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
task_uid: The uid of the task - Number - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
task_uid: The uid of the task - Number - required
admin
meili task "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "3"
mentdb
{"task_uid": 3, "index_uid": "movies", "status": "succeeded", "type": "documentAdditionOrUpdate", "error": null, "details": {"receivedDocuments": 1, "indexedDocuments": 1}, "duration": "PT0.011116S", "enqueued_at": "2026-11-17T11:24:06.954562Z", "finished_at": "2026-11-17T11:24:06.969417Z"}
meili task <config> <task_uid> <options_json>
Description
A task with options: wait (false: its current state), wait_timeout_ms
A task with options: wait (false: its current state), wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
task_uid: The uid of the task - Number - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
task_uid: The uid of the task - Number - required
options_json: The options - String - required
admin
meili task "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "0" "{\"wait\": false}"
mentdb
{"task_uid": 0, "index_uid": "movies", "status": "succeeded", "type": "indexCreation", "error": null, "details": {"primaryKey": null}, "duration": "PT0.016174S", "enqueued_at": "2026-11-17T11:24:06.868875Z", "finished_at": "2026-11-17T11:24:06.889485Z"}
meili info <config>
Description
The server: {version, commit_date, database_size, last_update, indexes (uid: documents)}
The server: {version, commit_date, database_size, last_update, indexes (uid: documents)}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
meili info "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}"
mentdb
{"version": "1.57.0", "commit_date": "2026-11-12T17:00:54.000000000Z", "database_size": 1523712, "last_update": "2026-11-17T11:24:06.961717Z", "indexes": {"books": 4, "movies": 1}}
meili settings_update <config> <index> <json_settings>
Description
Change settings (only the given ones): filterableAttributes, sortableAttributes, searchableAttributes, rankingRules, synonyms, stopWords, typoTolerance... Returns the task
Change settings (only the given ones): filterableAttributes, sortableAttributes, searchableAttributes, rankingRules, synonyms, stopWords, typoTolerance... Returns the task
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_settings: The settings - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_settings: The settings - String - required
admin
meili settings_update "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"filterableAttributes\": [\"author\", \"year\"], \"sortableAttributes\": [\"year\", \"price\"]}"
mentdb
{"task_uid": 4, "index_uid": "books", "status": "succeeded", "type": "settingsUpdate", "error": null, "details": {"filterableAttributes": ["author", "year"], "sortableAttributes": ["price", "year"]}, "duration": "PT0.013096S", "enqueued_at": "2026-11-17T11:24:06.984413Z", "finished_at": "2026-11-17T11:24:07.001417Z"}
meili settings_update <config> <index> <json_settings> <json_params>
Description
Change settings with options: wait, wait_timeout_ms
Change settings with options: wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_settings: The settings - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_settings: The settings - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
admin
meili settings_update "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"synonyms\": {\"roman\": [\"livre\"]}}" "{\"wait\": true}"
mentdb
{"task_uid": 5, "index_uid": "books", "status": "succeeded", "type": "settingsUpdate", "error": null, "details": {"synonyms": {"roman": ["livre"]}}, "duration": "PT0.007162S", "enqueued_at": "2026-11-17T11:24:07.011234Z", "finished_at": "2026-11-17T11:24:07.021408Z"}
meili settings <config> <index>
Description
All the settings of an index
All the settings of an index
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
admin
meili settings "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies"
mentdb
{"displayedAttributes": ["*"], "searchableAttributes": ["*"], "filterableAttributes": [], "sortableAttributes": [], "rankingRules": ["words", "typo", "proximity", "attributeRank", "sort", "wordPosition", "exactness"], "stopWords": [], "nonSeparatorTokens": [], "separatorTokens": [], "dictionary": [], "synonyms": {}, "distinctAttribute": null, "proximityPrecision": "byWord", "typoTolerance": {"enabled": true, "minWordSizeForTypos": {"oneTypo": 5, "twoTypos": 9}, "disableOnWords": [], "disableOnAttributes": [], "disableOnNumbers": false}, "faceting": {"maxValuesPerFacet": 100, "sortFacetValuesBy": {"*": "alpha"}}, "pagination": {"maxTotalHits": 1000}, "embedders": {}, "searchCutoffMs": null, "localizedAttributes": null, "facetSearch": true, "prefixSearch": "indexingTime"}
meili collection_info <config> <index>
Description
An index: {name, primary_key, created_at, updated_at, documents, is_indexing, settings}
An index: {name, primary_key, created_at, updated_at, documents, is_indexing, settings}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
admin
meili collection_info "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies"
mentdb
{"name": "movies", "primary_key": "movie_id", "created_at": "2026-11-17T11:24:06.873551Z", "updated_at": "2026-11-17T11:24:06.961717Z", "documents": 1, "is_indexing": false, "settings": {"displayedAttributes": ["*"], "searchableAttributes": ["*"], "filterableAttributes": [], "sortableAttributes": [], "rankingRules": ["words", "typo", "proximity", "attributeRank", "sort", "wordPosition", "exactness"], "stopWords": [], "nonSeparatorTokens": [], "separatorTokens": [], "dictionary": [], "synonyms": {}, "distinctAttribute": null, "proximityPrecision": "byWord", "typoTolerance": {"enabled": true, "minWordSizeForTypos": {"oneTypo": 5, "twoTypos": 9}, "disableOnWords": [], "disableOnAttributes": [], "disableOnNumbers": false}, "faceting": {"maxValuesPerFacet": 100, "sortFacetValuesBy": {"*": "alpha"}}, "pagination": {"maxTotalHits": 1000}, "embedders": {}, "searchCutoffMs": null, "localizedAttributes": null, "facetSearch": true, "prefixSearch": "indexingTime"}}
meili put <config> <index> <id> <document_json>
Description
Insert or replace one document: the primary key of the index gets the id (a number only in its canonical form like 70; 007 or -5 stay strings). Returns {id, result}
Insert or replace one document: the primary key of the index gets the id (a number only in its canonical form like 70; 007 or -5 stay strings). Returns {id, result}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
admin
meili put "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "5" "{\"title\": \"Nana\", \"author\": \"Zola\", \"year\": 1880, \"price\": 6.0}"
mentdb
{"id": 5, "result": "indexed"}
meili put <config> <index> <id> <document_json> <json_params>
Description
Put with options: wait, wait_timeout_ms
Put with options: wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
admin
meili put "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "6" "{\"title\": \"Candide\", \"author\": \"Voltaire\", \"year\": 1759, \"price\": 4.5}" "{\"wait\": false}"
mentdb
{"task_uid": 7, "index_uid": "books", "status": "enqueued", "type": "documentAdditionOrUpdate", "error": null, "duration": null, "enqueued_at": "2026-11-17T11:24:07.072213Z", "finished_at": null}
meili search <config> <index>
Description
All the documents of an index (20 by default) as rows
All the documents of an index (20 by default) as rows
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
admin
meili search "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies"
mentdb
[{"movie_id": 1, "title": "Amélie"}]
meili search <config> <index> <json_search>
Description
A search: a plain text is the query, a JSON object is the body (q, filter, sort, limit, offset, attributesToRetrieve, facets, showRankingScore, hybrid...). The hits as rows
A search: a plain text is the query, a JSON object is the body (q, filter, sort, limit, offset, attributesToRetrieve, facets, showRankingScore, hybrid...). The hits as rows
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_search: The text or the body - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_search: The text or the body - String - required
admin
meili search "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "miserable"
mentdb
[{"id": 1, "title": "Les Misérables", "author": "Hugo", "year": 1862, "price": 12.5}]
a filter, a sort and the score (fixed result: real Meilisearch 1.57.0)
admin
meili search "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"q\": \"\", \"filter\": \"author = Hugo\", \"sort\": [\"year:asc\"], \"attributesToRetrieve\": [\"id\", \"title\", \"year\"], \"showRankingScore\": true}"
mentdb
[{"id": 2, "title": "Notre-Dame de Paris", "year": 1831, "_rankingScore": 1}, {"id": 1, "title": "Les Misérables", "year": 1862, "_rankingScore": 1}]
meili search <config> <index> <json_search> <options_json>
Description
A search with options: full (true: {total, exact, took_ms, rows, facets, facet_stats})
A search with options: full (true: {total, exact, took_ms, rows, facets, facet_stats})
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_search: The text or the body - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
json_search: The text or the body - String - required
options_json: The options - String - required
admin
meili search "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"q\": \"\", \"facets\": [\"author\"], \"limit\": 2}" "{\"full\": true}"
mentdb
{"total": 5, "exact": false, "took_ms": 0, "rows": [{"id": 1, "title": "Les Misérables", "author": "Hugo", "year": 1862, "price": 12.5}, {"id": 2, "title": "Notre-Dame de Paris", "author": "Hugo", "year": 1831, "price": 9.9}], "facets": {"author": {"Flaubert": 1, "Hugo": 2, "Zola": 2}}, "facet_stats": {}}
meili find <config> <index> <filter_json>
Description
The documents of a filter as rows (1000 by default)
The documents of a filter as rows (1000 by default)
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
admin
meili find "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"author\": \"Hugo\"}"
mentdb
[{"id": 1, "title": "Les Misérables", "author": "Hugo", "year": 1862, "price": 12.5}, {"id": 2, "title": "Notre-Dame de Paris", "author": "Hugo", "year": 1831, "price": 9.9}]
meili find <config> <index> <filter_json> <options_json>
Description
The documents of a filter with options: limit (1000, 1000000 at most), skip, sort (sortable attributes, like "year:desc"), fields
The documents of a filter with options: limit (1000, 1000000 at most), skip, sort (sortable attributes, like "year:desc"), fields
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
options_json: The options: limit, skip, sort ("year:desc,title"), fields (a list or "a,b") - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
options_json: The options: limit, skip, sort ("year:desc,title"), fields (a list or "a,b") - String - required
admin
meili find "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "year < 1870" "{\"sort\": \"year:desc\", \"fields\": [\"id\", \"title\", \"year\"]}"
mentdb
[{"id": 1, "title": "Les Misérables", "year": 1862}, {"id": 3, "title": "Madame Bovary", "year": 1857}, {"id": 2, "title": "Notre-Dame de Paris", "year": 1831}]
meili count <config> <index>
Description
The number of documents
The number of documents
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
admin
meili count "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books"
mentdb
6
meili count <config> <index> <filter_json>
Description
The number of documents of a filter (exact)
The number of documents of a filter (exact)
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
admin
meili count "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"author\": [\"Hugo\", \"Zola\"]}"
mentdb
4
meili update <config> <index> <filter_json> <changes_json>
Description
Set fields on the documents of a filter (their primary keys are fetched, then a partial update; 100000 at most). Returns {matched, modified}
Set fields on the documents of a filter (their primary keys are fetched, then a partial update; 100000 at most). Returns {matched, modified}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
changes_json: The fields to set, as a JSON object - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
changes_json: The fields to set, as a JSON object - String - required
admin
meili update "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"author\": \"Hugo\"}" "{\"status\": \"classic\"}"
mentdb
{"matched": 2, "modified": 2}
meili update <config> <index> <filter_json> <changes_json> <options_json>
Description
Update with options: limit (100000), wait, wait_timeout_ms
Update with options: limit (100000), wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
changes_json: The fields to set, as a JSON object - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
changes_json: The fields to set, as a JSON object - String - required
options_json: The options - String - required
admin
meili update "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "year > 1870" "{\"status\": \"naturalist\"}" "{\"limit\": 1000}"
mentdb
{"matched": 2, "modified": 2}
meili update_rows <config> <index> <rows_json>
Description
Update documents from MQL rows: only the given fields change (the primary key is required). Returns {modified, errors, tasks}
Update documents from MQL rows: only the given fields change (the primary key is required). Returns {modified, errors, tasks}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
admin
meili update_rows "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "[{\"id\": 3, \"price\": 6.9}]"
mentdb
{"modified": 1, "errors": [], "tasks": [10]}
meili update_rows <config> <index> <rows_json> <options_json>
Description
Update rows with options: primary_key, batch_size, wait, wait_timeout_ms
Update rows with options: primary_key, batch_size, wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
admin
meili update_rows "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "[{\"id\": 1, \"price\": 11.0}, {\"id\": 2, \"price\": 9.5}]" "{\"batch_size\": 1}"
mentdb
{"modified": 2, "errors": [], "tasks": [11, 12]}
meili get <config> <index> <id>
Description
A document, null if it does not exist
A document, null if it does not exist
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
id: The id - String - required
admin
meili get "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "3"
mentdb
{"id": 3, "title": "Madame Bovary", "author": "Flaubert", "year": 1857, "price": 6.9}
no such id (fixed result: real Meilisearch 1.57.0)
admin
meili get "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "99"
mentdb
null
meili delete <config> <index> <ids>
Description
Delete documents by id: an id, or a JSON array of ids. Returns {deleted}
Delete documents by id: an id, or a JSON array of ids. Returns {deleted}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
ids: An id or a JSON array of ids - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
ids: An id or a JSON array of ids - String - required
admin
meili delete "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "4"
mentdb
{"deleted": 1}
meili delete <config> <index> <ids> <json_params>
Description
Delete by id with options: wait (false: the enqueued task), wait_timeout_ms
Delete by id with options: wait (false: the enqueued task), wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
ids: An id or a JSON array of ids - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
ids: An id or a JSON array of ids - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
admin
meili delete "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "[6]" "{\"wait\": false}"
mentdb
{"task_uid": 14, "index_uid": "books", "status": "enqueued", "type": "documentDeletion", "error": null, "duration": null, "enqueued_at": "2026-11-17T11:24:07.238877Z", "finished_at": null}
meili delete_where <config> <index> <filter_json>
Description
Delete the documents of a filter (not empty). Returns {deleted}
Delete the documents of a filter (not empty). Returns {deleted}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
admin
meili delete_where "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"author\": \"Flaubert\"}"
mentdb
{"deleted": 1}
meili delete_where <config> <index> <filter_json> <json_params>
Description
Delete by filter with options: wait, wait_timeout_ms
Delete by filter with options: wait, wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
index: The index uid (letters, digits, - and _) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (null = IS NULL; a text value cannot end with a backslash); or a filter text like year < 1860 AND author = Hugo (the attributes must be filterable) - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
admin
meili delete_where "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "year > 1800" "{\"wait_timeout_ms\": 10000}"
mentdb
{"deleted": 3}
meili request <config> <method> <path>
Description
Any endpoint (path relative to the url): the JSON answer, or the text
Any endpoint (path relative to the url): the JSON answer, or the text
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path with an optional query string - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path with an optional query string - String - required
admin
meili request "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "GET" "/indexes/books/stats"
mentdb
{"numberOfDocuments": 0, "indexSize": 933888, "usedIndexSize": 81920, "rawDocumentDbSize": 0, "avgDocumentSize": 0, "isIndexing": false, "numberOfEmbeddings": 0, "numberOfEmbeddedDocuments": 0, "fieldDistribution": {}}
meili request <config> <method> <path> <body_json>
Description
Any endpoint with a JSON body
Any endpoint with a JSON body
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path - String - required
body_json: The body - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path - String - required
body_json: The body - String - required
admin
meili request "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "POST" "/multi-search" "{\"queries\": [{\"indexUid\": \"movies\", \"q\": \"amelie\", \"limit\": 1}]}"
mentdb
{"results": [{"indexUid": "movies", "hits": [{"movie_id": 1, "title": "Amélie"}], "query": "amelie", "processingTimeMs": 0, "limit": 1, "offset": 0, "estimatedTotalHits": 1, "requestUid": "01a1e93f-fd2f-7671-be21-5580439dc381"}]}
meili collection_drop <config> <name>
Description
Delete an index and its documents. Returns {dropped, existed}
Delete an index and its documents. Returns {dropped, existed}
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
admin
meili collection_drop "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "movies"
mentdb
{"dropped": "movies", "existed": true}
no such index (fixed result: real Meilisearch 1.57.0)
admin
meili collection_drop "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "films"
mentdb
{"dropped": "films", "existed": false}
meili collection_drop <config> <name> <json_params>
Description
Delete an index with options: wait (false: the enqueued task), wait_timeout_ms
Delete an index with options: wait (false: the enqueued task), wait_timeout_ms
Parameters
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
config: The configuration as JSON: url (http://localhost:7700), api_key (or api_key: the master key or an API key, sent as a bearer token), ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The index uid - String - required
json_params: The parameters: wait (true: the asynchronous task is awaited and a failed task is an error; false: the enqueued task is returned at once), wait_timeout_ms (120000) - String - required
admin
meili collection_drop "{\"url\": \"http://localhost:7700\", \"api_key\": \"meili_key\"}" "books" "{\"wait\": true}"
mentdb
{"dropped": "books", "existed": true}
