{"@context": "https://schema.org", "@type": "WebAPI", "name": "Meilisearch v1.0 API", "description": "Meilisearch v1.0, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "meilisearch.com"}, "documentation": "https://raw.githubusercontent.com/meilisearch/documentation/master/.vuepress/public/postman/meilisearch-collection.json"}
Index / APIs / meilisearch.com

Meilisearch v1.0 API

Meilisearch v1.0, an HTTP API described by an OpenAPI document.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: http://localhost:7700

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Meilisearch v1.0 v1.0.0

Meilisearch v1.0, an HTTP API described by an OpenAPI document.

methodpathwhat the vendor says it does
POST/dumpsCreate a dump Create a dump Dumps
GET/healthHealth Health Stats
GET/indexesGet indexes Get indexes Indexes
POST/indexesCreate index with primary key Create index with primary key Indexes
GET/indexes/booksShow index Show index Indexes
PATCH/indexes/booksUdpate index Can only change the document identifier if it has not already been added before. Indexes
DELETE/indexes/booksDelete an index Delete an index Indexes
GET/indexes/books/documentsGet documents Get documents Documents
POST/indexes/books/documentsAdd or replace documents Add or replace documents Documents
PUT/indexes/books/documentsAdd or update documents Add or update documents Documents
DELETE/indexes/books/documentsDelete all documents Delete all documents Documents
DELETE/indexes/books/documents/1Delete one document Delete one document Documents
GET/indexes/books/documents/2Get one document Get one document Documents
POST/indexes/books/documents/delete-batchDelete documents Delete documents Documents
GET/indexes/books/searchSearch in index Search in index Search
POST/indexes/books/searchSearch in index Search in index Search
GET/indexes/books/settingsGet all settings Get all settings Settings
PATCH/indexes/books/settingsUpdate settings Update settings Settings
DELETE/indexes/books/settingsReset all settings Reset all settings Settings
GET/indexes/books/settings/displayed-attributesGet displayed attributes Get displayed attributes Settings Sub-routes
PUT/indexes/books/settings/displayed-attributesUpdate displayed attributes Update displayed attributes Settings Sub-routes
DELETE/indexes/books/settings/displayed-attributesReset displayed attributes Reset displayed attributes Settings Sub-routes
GET/indexes/books/settings/distinct-attributeGet distinct attribute Get distinct attribute Settings Sub-routes
PUT/indexes/books/settings/distinct-attributeUpdate distinct attribute Update distinct attribute Settings Sub-routes
DELETE/indexes/books/settings/distinct-attributeReset distinct attribute Reset distinct attribute Settings Sub-routes
GET/indexes/books/settings/facetingGet faceting Get faceting Settings Sub-routes
PATCH/indexes/books/settings/facetingUpdate faceting Update faceting Settings Sub-routes
DELETE/indexes/books/settings/facetingReset faceting Reset faceting Settings Sub-routes
GET/indexes/books/settings/filterable-attributesGet filterable attributes Get filterable attributes Settings Sub-routes
PUT/indexes/books/settings/filterable-attributesUpdate filterable attributes Update filterable attributes Settings Sub-routes
DELETE/indexes/books/settings/filterable-attributesReset filterable attributes Reset filterable attributes Settings Sub-routes
GET/indexes/books/settings/paginationGet pagination Get pagination Settings Sub-routes
PATCH/indexes/books/settings/paginationUpdate pagination Update pagination Settings Sub-routes
DELETE/indexes/books/settings/paginationReset pagination Reset pagination Settings Sub-routes
GET/indexes/books/settings/ranking-rulesGet ranking rules Get ranking rules Settings Sub-routes
PUT/indexes/books/settings/ranking-rulesUpdate ranking rules Update ranking rules Settings Sub-routes
DELETE/indexes/books/settings/ranking-rulesReset ranking rules Reset ranking rules Settings Sub-routes
GET/indexes/books/settings/searchable-attributesGet searchable attributes Get searchable attributes Settings Sub-routes
PUT/indexes/books/settings/searchable-attributesUpdate searchable attributes Update searchable attributes Settings Sub-routes
DELETE/indexes/books/settings/searchable-attributesReset searchable attributes Reset searchable attributes Settings Sub-routes

and 25 more operation(s) in this specification, all searchable.

specification origin: https://raw.githubusercontent.com/meilisearch/documentation/master/.vuepress/public/postma

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.