Meilisearch

Meilisearch v1.0

Meilisearch v1.0 endpoints from Meilisearch

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Meilisearch v1.0 endpoints from Meilisearch

Endpoints 65

Documents

  • GETGet documents/indexes/books/documents?limit=1&offset=10&fields=idGet documents
  • PUTAdd or update documents/indexes/books/documents?primaryKey=idAdd or update documents
  • POSTAdd or replace documents/indexes/books/documents?primaryKey=idAdd or replace documents
  • DELETEDelete all documents/indexes/books/documentsDelete all documents
  • DELETEDelete one document/indexes/books/documents/1Delete one document
  • GETGet one document/indexes/books/documents/2?fields=idGet one document
  • POSTDelete documents/indexes/books/documents/delete-batchDelete documents

Search

  • GETSearch in index/indexes/books/search?q=prinec&offset=0&limit=1&attributesToRetrieve=title,author&attributesToCrop=title&attributesToHighlight=*&cropLength=5&cropMarker=[...]&filter=genre="fantasy"&showMatchesPosition=true&facets=genre&sort=price&highlightPreTag=<mark>&highlightPostTag=</mark>&matchingStrategy=all&page=2&hitsPerPage=50Search in index
  • POSTSearch in index/indexes/books/searchSearch in index

Tasks

  • GETGet all tasks/tasks?uids=3&indexUids=books&types=documentAdditionOrUpdate&statuses=failed&beforeEnqueuedAt=string&afterEnqueuedAt=string&beforeStartedAt=string&afterStartedAt=string&beforeFinishedAt=string&afterFinishedAt=string&canceledBy=string&limit=2&from=10Get all tasks
  • DELETEDelete tasks/tasks?uids=string&indexUids=books&types=documentAdditionOrUpdate&statuses=failed&beforeEnqueuedAt=string&afterEnqueuedAt=string&beforeStartedAt=string&afterStartedAt=string&beforeFinishedAt=string&afterFinishedAt=string&canceledBy=string&limit=2&from=10Delete tasks
  • GETGet one task/tasks/0Get one task
  • POSTCancel tasks/tasks/cancel?uids=string&indexUids=books&types=documentAdditionOrUpdate&statuses=failed&beforeEnqueuedAt=string&afterEnqueuedAt=string&beforeStartedAt=string&afterStartedAt=string&beforeFinishedAt=string&afterFinishedAt=string&canceledBy=string&limit=2&from=10Cancel tasks

Indexes

  • GETGet indexes/indexes?offset=0&limit=2Get indexes
  • POSTCreate index with primary key/indexesCreate index with primary key
  • GETShow index/indexes/booksShow index
  • DELETEDelete an index/indexes/booksDelete an index
  • PATCHUdpate index /indexes/booksCan only change the document identifier if it has not already been added before.
  • POSTSwap indexes/indexes/swap-indexesSwap indexes

Settings

  • GETGet all settings/indexes/books/settingsGet all settings
  • DELETEReset all settings/indexes/books/settingsReset all settings
  • PATCHUpdate settings/indexes/books/settingsUpdate settings
  • GETGet displayed attributes/indexes/books/settings/displayed-attributesGet displayed attributes
  • PUTUpdate displayed attributes/indexes/books/settings/displayed-attributesUpdate displayed attributes
  • DELETEReset displayed attributes/indexes/books/settings/displayed-attributesReset displayed attributes
  • GETGet distinct attribute/indexes/books/settings/distinct-attributeGet distinct attribute
  • PUTUpdate distinct attribute/indexes/books/settings/distinct-attributeUpdate distinct attribute
  • DELETEReset distinct attribute/indexes/books/settings/distinct-attributeReset distinct attribute
  • GETGet faceting/indexes/books/settings/facetingGet faceting
  • DELETEReset faceting/indexes/books/settings/facetingReset faceting
  • PATCHUpdate faceting/indexes/books/settings/facetingUpdate faceting
  • GETGet filterable attributes/indexes/books/settings/filterable-attributesGet filterable attributes
  • PUTUpdate filterable attributes/indexes/books/settings/filterable-attributesUpdate filterable attributes
  • DELETEReset filterable attributes/indexes/books/settings/filterable-attributesReset filterable attributes
  • GETGet pagination/indexes/books/settings/paginationGet pagination
  • DELETEReset pagination/indexes/books/settings/paginationReset pagination
  • PATCHUpdate pagination/indexes/books/settings/paginationUpdate pagination
  • GETGet ranking rules/indexes/books/settings/ranking-rulesGet ranking rules
  • PUTUpdate ranking rules/indexes/books/settings/ranking-rulesUpdate ranking rules
  • DELETEReset ranking rules/indexes/books/settings/ranking-rulesReset ranking rules
  • GETGet searchable attributes/indexes/books/settings/searchable-attributesGet searchable attributes
  • PUTUpdate searchable attributes/indexes/books/settings/searchable-attributesUpdate searchable attributes
  • DELETEReset searchable attributes/indexes/books/settings/searchable-attributesReset searchable attributes
  • GETGet sortable attributes/indexes/books/settings/sortable-attributesGet sortable attributes
  • PUTUpdate sortable attributes/indexes/books/settings/sortable-attributesUpdate sortable attributes
  • DELETEReset sortable attributes/indexes/books/settings/sortable-attributesReset sortable attributes
  • GETGet stop-words/indexes/books/settings/stop-wordsGet stop-words
  • PUTUpdate stop-words/indexes/books/settings/stop-wordsUpdate stop-words
  • DELETEReset stop-words/indexes/books/settings/stop-wordsReset stop-words
  • GETGet synonyms/indexes/books/settings/synonymsGet synonyms
  • PUTUpdate synonyms/indexes/books/settings/synonymsUpdate synonyms
  • DELETEReset synonyms/indexes/books/settings/synonymsReset synonyms
  • GETGet typo-tolerance/indexes/books/settings/typo-toleranceGet typo-tolerance
  • DELETEReset typo-tolerance/indexes/books/settings/typo-toleranceReset typo-tolerance
  • PATCHUpdate typo-tolerance/indexes/books/settings/typo-toleranceUpdate typo-tolerance

Key Management

  • GETGet keys/keys?offset=0&limit=10Get keys
  • POSTCreate a key/keysCreate a key
  • GETGet one key/keys/L8l05tFb188aab693735bbaf1f898b9902fb39f865160d39dddba2b47b940115a0430705Get one key
  • DELETEDelete a key/keys/kN2aK9EO8a7b627e425717d9196c8081552ca004e513545ed178f8a56981dbd3080d4a5bDelete a key
  • PATCHUpdate a key/keys/wYZjGJyBcdb0621b97999c233246a8ec0a35d0fcd9a6417ef8ccee0c8978b64b123af2ddUpdate a key

Stats

  • GETHealth/healthHealth
  • GETStats of an index/indexes/books/statsStats of an index
  • GETGlobal stats/statsGlobal stats
  • GETVersion/versionVersion

Dumps

  • POSTCreate a dump/dumpsCreate a dump

API details

Base URL
http://localhost:7700
Authentication
None declared in the description
Operations
65 operations on 32 pathsGET 25DELETE 17PUT 9POST 8PATCH 6
Main resources
Settings 36Sub-routes 33Documents 7Indexes 6Key Management 5Stats 4Tasks 4Search 2Dumps 1
Description format
OpenAPI 3.0.3, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Meilisearch v1.0 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Meilisearch v1.0 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get documents” (GET /indexes/books/documents?limit=1&offset=10&fields=id), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Meilisearch v1.0?

Meilisearch v1.0 endpoints from Meilisearch It is listed under Other and has 65 endpoints.

Who publishes the Meilisearch v1.0?

It is listed from Meilisearch's public API description (an OpenAPI document), not published by Meilisearch on Swastik Codes. Anyone who controls meilisearch.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Meilisearch v1.0?

Requests go to http://localhost:7700. Endpoint paths are added to this base URL.

How do I authenticate with the Meilisearch v1.0?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Meilisearch v1.0 have?

65 operations on 32 paths (25 GET, 17 DELETE, 9 PUT, 8 POST, 6 PATCH). The largest groups are Settings, Sub-routes, Documents, Indexes.

Is forking the Meilisearch v1.0 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.