{"@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"}
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, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
POST | /dumps | Create a dump Create a dump Dumps |
GET | /health | Health Health Stats |
GET | /indexes | Get indexes Get indexes Indexes |
POST | /indexes | Create index with primary key Create index with primary key Indexes |
GET | /indexes/books | Show index Show index Indexes |
PATCH | /indexes/books | Udpate index Can only change the document identifier if it has not already been added before. Indexes |
DELETE | /indexes/books | Delete an index Delete an index Indexes |
GET | /indexes/books/documents | Get documents Get documents Documents |
POST | /indexes/books/documents | Add or replace documents Add or replace documents Documents |
PUT | /indexes/books/documents | Add or update documents Add or update documents Documents |
DELETE | /indexes/books/documents | Delete all documents Delete all documents Documents |
DELETE | /indexes/books/documents/1 | Delete one document Delete one document Documents |
GET | /indexes/books/documents/2 | Get one document Get one document Documents |
POST | /indexes/books/documents/delete-batch | Delete documents Delete documents Documents |
GET | /indexes/books/search | Search in index Search in index Search |
POST | /indexes/books/search | Search in index Search in index Search |
GET | /indexes/books/settings | Get all settings Get all settings Settings |
PATCH | /indexes/books/settings | Update settings Update settings Settings |
DELETE | /indexes/books/settings | Reset all settings Reset all settings Settings |
GET | /indexes/books/settings/displayed-attributes | Get displayed attributes Get displayed attributes Settings Sub-routes |
PUT | /indexes/books/settings/displayed-attributes | Update displayed attributes Update displayed attributes Settings Sub-routes |
DELETE | /indexes/books/settings/displayed-attributes | Reset displayed attributes Reset displayed attributes Settings Sub-routes |
GET | /indexes/books/settings/distinct-attribute | Get distinct attribute Get distinct attribute Settings Sub-routes |
PUT | /indexes/books/settings/distinct-attribute | Update distinct attribute Update distinct attribute Settings Sub-routes |
DELETE | /indexes/books/settings/distinct-attribute | Reset distinct attribute Reset distinct attribute Settings Sub-routes |
GET | /indexes/books/settings/faceting | Get faceting Get faceting Settings Sub-routes |
PATCH | /indexes/books/settings/faceting | Update faceting Update faceting Settings Sub-routes |
DELETE | /indexes/books/settings/faceting | Reset faceting Reset faceting Settings Sub-routes |
GET | /indexes/books/settings/filterable-attributes | Get filterable attributes Get filterable attributes Settings Sub-routes |
PUT | /indexes/books/settings/filterable-attributes | Update filterable attributes Update filterable attributes Settings Sub-routes |
DELETE | /indexes/books/settings/filterable-attributes | Reset filterable attributes Reset filterable attributes Settings Sub-routes |
GET | /indexes/books/settings/pagination | Get pagination Get pagination Settings Sub-routes |
PATCH | /indexes/books/settings/pagination | Update pagination Update pagination Settings Sub-routes |
DELETE | /indexes/books/settings/pagination | Reset pagination Reset pagination Settings Sub-routes |
GET | /indexes/books/settings/ranking-rules | Get ranking rules Get ranking rules Settings Sub-routes |
PUT | /indexes/books/settings/ranking-rules | Update ranking rules Update ranking rules Settings Sub-routes |
DELETE | /indexes/books/settings/ranking-rules | Reset ranking rules Reset ranking rules Settings Sub-routes |
GET | /indexes/books/settings/searchable-attributes | Get searchable attributes Get searchable attributes Settings Sub-routes |
PUT | /indexes/books/settings/searchable-attributes | Update searchable attributes Update searchable attributes Settings Sub-routes |
DELETE | /indexes/books/settings/searchable-attributes | Reset 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.