Meilisearch Core API

Meilisearch Core API

API version: 1.7.0

Auth

Bearer bearer

Base URL

{protocol}://{domain}:{port}

Setup

1. Set Authorization header with your Bearer token
2. GET /health -- verify access
3. POST /dumps -- create first dumps

Endpoints

73 endpoints across 12 groups. See references/api-spec.lap for full details.

dumps

snapshots

health

indexes

multi-search

keys

stats

version

tasks

swap-indexes

experimental-features

metrics

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a dump?" -> POST /dumps
• "Create a snapshot?" -> POST /snapshots
• "List all health?" -> GET /health
• "List all indexes?" -> GET /indexes
• "Create a indexe?" -> POST /indexes
• "Get indexe details?" -> GET /indexes/{indexUid}
• "Partially update a indexe?" -> PATCH /indexes/{indexUid}
• "Delete a indexe?" -> DELETE /indexes/{indexUid}
• "List all documents?" -> GET /indexes/{indexUid}/documents
• "Create a document?" -> POST /indexes/{indexUid}/documents
• "Create a fetch?" -> POST /indexes/{indexUid}/documents/fetch
• "Create a delete-batch?" -> POST /indexes/{indexUid}/documents/delete-batch
• "Create a delete?" -> POST /indexes/{indexUid}/documents/delete
• "Get document details?" -> GET /indexes/{indexUid}/documents/{documentId}
• "Delete a document?" -> DELETE /indexes/{indexUid}/documents/{documentId}
• "Search search?" -> GET /indexes/{indexUid}/search
• "Create a search?" -> POST /indexes/{indexUid}/search
• "Create a facet-search?" -> POST /indexes/{indexUid}/facet-search
• "List all settings?" -> GET /indexes/{indexUid}/settings
• "List all synonyms?" -> GET /indexes/{indexUid}/settings/synonyms
• "List all sortable-attributes?" -> GET /indexes/{indexUid}/settings/sortable-attributes
• "List all stop-words?" -> GET /indexes/{indexUid}/settings/stop-words
• "List all ranking-rules?" -> GET /indexes/{indexUid}/settings/ranking-rules
• "List all typo-tolerance?" -> GET /indexes/{indexUid}/settings/typo-tolerance
• "List all pagination?" -> GET /indexes/{indexUid}/settings/pagination
• "List all faceting?" -> GET /indexes/{indexUid}/settings/faceting
• "List all filterable-attributes?" -> GET /indexes/{indexUid}/settings/filterable-attributes
• "List all distinct-attribute?" -> GET /indexes/{indexUid}/settings/distinct-attribute
• "List all searchable-attributes?" -> GET /indexes/{indexUid}/settings/searchable-attributes
• "List all displayed-attributes?" -> GET /indexes/{indexUid}/settings/displayed-attributes
• "List all stats?" -> GET /indexes/{indexUid}/stats
• "Create a multi-search?" -> POST /multi-search
• "List all keys?" -> GET /keys
• "Create a key?" -> POST /keys
• "Get key details?" -> GET /keys/{uid_or_key}
• "Delete a key?" -> DELETE /keys/{uid_or_key}
• "Partially update a key?" -> PATCH /keys/{uid_or_key}
• "List all stats?" -> GET /stats
• "List all version?" -> GET /version
• "List all tasks?" -> GET /tasks
• "List all :taskUid?" -> GET /tasks/:taskUid
• "Create a cancel?" -> POST /tasks/cancel
• "Create a swap-indexe?" -> POST /swap-indexes
• "List all experimental-features?" -> GET /experimental-features
• "List all metrics?" -> GET /metrics
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP