MeiliSearch API changelog

Last update:

Subscribe to the MeiliSearch API changelog to be up to date on recent changes.

• RSS Feed

Documentation content has changed

View version

API structure has changed

View changes
  • Updated: POST /indexes
  • Header added: Content-Type
  • Updated: PUT /indexes/{indexUid}
  • Header added: Content-Type
  • Updated: PUT /indexes/{indexUid}/documents
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/documents
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/documents/delete-batch
  • Header added: Content-Type
  • Updated: GET /indexes/{indexUid}/search
  • Response modified: 200
  • Updated: POST /indexes/{indexUid}/search
  • Header added: Content-Type
  • Response modified: 200
  • Updated: POST /indexes/{indexUid}/settings
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/synonyms
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/sortable-attributes
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/stop-words
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/ranking-rules
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/filterable-attributes
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/distinct-attribute
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/searchable-attributes
  • Header added: Content-Type
  • Updated: POST /indexes/{indexUid}/settings/displayed-attributes
  • Header added: Content-Type

API structure has changed

View changes
  • Updated: GET /indexes/{indexUid}/search
  • Query parameter added: sort
  • Updated: POST /indexes/{indexUid}/search
  • Body attribute added: sort
  • Updated: GET /indexes/{indexUid}/settings
  • Response modified: 200
  • Body attribute added: sortableAttributes
  • Updated: POST /indexes/{indexUid}/settings
  • Body attribute added: sortableAttributes
  • Added: GET /indexes/{indexUid}/settings/sortable-attributes
  • Added: POST /indexes/{indexUid}/settings/sortable-attributes
  • Added: DELETE /indexes/{indexUid}/settings/sortable-attributes

Documentation content has changed

View version

API structure has changed

View changes
  • Updated: GET /indexes/{indexUid}/documents
  • Query parameter modified: attributesToRetrieve
  • Updated: GET /indexes/{indexUid}/search
  • Query parameters modified: attributesToRetrieve, attributesToHighlight, attributesToCrop, cropLength, facetsDistribution, filter, matches
  • Updated: POST /indexes/{indexUid}/search
  • Body attribute modified: filter

API structure has changed

View changes
  • Updated: GET /version
  • Response modified: 200
  • Body attribute added: commitDate
  • Body attribute removed: buildDate

API structure has changed

View changes
  • Updated: GET /indexes
  • Response added: 401
  • Response modified: 200
  • Body attribute added: name
  • Body attribute modified: primaryKey
  • Updated: POST /indexes
  • Responses added: 400, 401
  • Response modified: 201
  • Body attribute added: name
  • Body attribute modified: primaryKey
  • Updated: GET /indexes/{indexUid}
  • Responses added: 401, 404
  • Response modified: 200
  • Body attribute added: name
  • Body attribute modified: primaryKey
  • Updated: PUT /indexes/{indexUid}
  • Responses added: 400, 401, 404
  • Response modified: 200
  • Body attribute added: name
  • Body attribute modified: primaryKey
  • Updated: DELETE /indexes/{indexUid}
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/documents
  • Query parameters added: limit, offset, attributesToRetrieve
  • Responses added: 401, 404
  • Response modified: 200
  • Body attribute added: Additional properties are allowed
  • Updated: PUT /indexes/{indexUid}/documents
  • Body attribute added: Additional properties are allowed
  • Responses added: 401, 413
  • Updated: POST /indexes/{indexUid}/documents
  • Responses added: 401, 413
  • Updated: DELETE /indexes/{indexUid}/documents
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/documents/delete-batch
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/documents/{documentId}
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/documents/{documentId}
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/search
  • Query parameters added: filter, attributesToRetrieve, limit, offset, matches
  • Query parameter removed: filters
  • Query parameters modified: q, attributesToCrop
  • Responses added: 401, 404
  • Response modified: 200
  • Body attributes added: facetsDistribution, exhaustiveFacetsCount, Additional properties are NOT allowed
  • Body attributes modified: offset, limit, nbHits, exhaustiveNbHits, processingTimeMs, query
  • Updated: POST /indexes/{indexUid}/search
  • Body attribute added: filter
  • Body attributes removed: filters,
  • Body attributes modified: q, attributesToRetrieve, attributesToHighlight, attributesToCrop, cropLength, matches, facetsDistribution, offset, limit, Additional properties are NOT allowed
  • Responses added: 401, 404
  • Response modified: 200
  • Body attributes added: facetsDistribution, exhaustiveFacetsCount, Additional properties are NOT allowed
  • Body attributes modified: offset, limit, nbHits, exhaustiveNbHits, processingTimeMs, query
  • Updated: GET /indexes/{indexUid}/updates
  • Responses added: 401, 404
  • Response modified: 200
  • Body attributes added: status, updateId, type, enqueuedAt, processedAt, duration, error
  • Updated: GET /indexes/{indexUid}/updates/{updateId}
  • Responses added: 401, 404
  • Response modified: 200
  • Body attribute modified: status
  • Updated: GET /keys
  • Response added: 401
  • Updated: GET /indexes/{indexUid}/settings
  • Responses added: 401, 404
  • Response modified: 200
  • Body attributes added: rankingRules, distinctAttribute, searchableAttributes, displayedAttributes, stopWords, synonyms, filterableAttributes
  • Updated: POST /indexes/{indexUid}/settings
  • Body attribute added: filterableAttributes
  • Body attribute removed: attributesForFaceting
  • Body attribute modified: synonyms
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/synonyms
  • Responses added: 401, 404
  • Response modified: 200
  • Body attribute removed: Additional properties:
  • Updated: POST /indexes/{indexUid}/settings/synonyms
  • Body attribute removed: Additional properties:
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/synonyms
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/stop-words
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/stop-words
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/stop-words
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/ranking-rules
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/ranking-rules
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/ranking-rules
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/filterable-attributes
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/filterable-attributes
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/filterable-attributes
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/distinct-attribute
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/distinct-attribute
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/distinct-attribute
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/searchable-attributes
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/searchable-attributes
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/searchable-attributes
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/settings/displayed-attributes
  • Responses added: 401, 404
  • Updated: POST /indexes/{indexUid}/settings/displayed-attributes
  • Responses added: 401, 404
  • Updated: DELETE /indexes/{indexUid}/settings/displayed-attributes
  • Responses added: 401, 404
  • Updated: GET /indexes/{indexUid}/stats
  • Responses added: 401, 404
  • Response modified: 200
  • Body attribute added: fieldDistribution
  • Body attribute removed: fieldsDistribution
  • Updated: GET /stats
  • Response added: 401
  • Response modified: 200
  • Updated: GET /version
  • Response added: 401
  • Updated: POST /dumps
  • Response added: 401
  • Response modified: 202
  • Body attributes added: startedAt, finishedAt
  • Body attribute modified: status
  • Removed: GET /dumps/status
  • Added: GET /dumps/{dumpUid}/status

API documentation has been created