Change Updates

Do not miss any Meilisearch API changes, ever again

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

RSS
Meilisearch API documentation

Changelog

Last update:
Compare
1.7.0

API structure has changed

5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /experimental-features
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scoreDetails attribute Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • metrics, exportPuffinReports attributes Added
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hits attribute Modified
PATCH /experimental-features
  • Body
  • application/json content type Modified
    • scoreDetails attribute Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • metrics, exportPuffinReports attributes Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scoreDetails attribute Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • metrics, exportPuffinReports attributes Added
POST /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • hits attribute Modified
POST /multi-search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results attribute Modified

Documentation content has changed

1.5.0

API structure has changed

2 structure changes including:
2 Additions
Added 2
DELETE /indexes/{indexUid}/documents/{documentId}
POST /snapshots

Documentation content has changed

1.3.0

API structure has changed

12 structure changes including:
1 Breaking change
3 Additions
9 Modifications
Modified 9 Breaking
DELETE /indexes/{indexUid}/documents/{documentId}
  • Header
  • Content-Type header Removed
  • Body
  • content type Removed
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • hits attribute Modified
GET /indexes/{indexUid}/settings
  • Response
  • 200 response Modified
    • faceting attribute Modified
GET /indexes/{indexUid}/settings/faceting
  • Response
  • 200 response Modified
    • sortFacetValuesBy attribute Added
GET /tasks
  • Response
  • 200 response Modified
    • total attribute Added
PATCH /indexes/{indexUid}/settings
  • Body
  • content type Modified
    • faceting attribute Modified
PATCH /indexes/{indexUid}/settings/faceting
  • Body
  • content type Modified
    • sortFacetValuesBy attribute Added
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • vector, showRankingScore, showRankingScoreDetails, attributesToSearchOn attributes Added
  • Response
  • 200 response Modified
    • hits attribute Modified
POST /multi-search
  • Body
  • content type Modified
    • queries attribute Modified
  • Response
  • 200 response Modified
    • results attribute Modified
Added 3
GET /experimental-features
PATCH /experimental-features
POST /indexes/{indexUid}/facet-search
1.2.0

API structure has changed

3 structure changes including:
1 Breaking change
1 Addition
2 Modifications
Modified 2 Breaking
GET /indexes/{indexUid}/documents
  • Query
  • filter query parameter Added
POST /indexes/{indexUid}/documents/delete
  • Header
  • Content-Type header Added
  • Body
  • content type Added
Added 1
POST /indexes/{indexUid}/documents/fetch
1.1.0

API structure has changed

6 structure changes including:
2 Additions
4 Modifications
Modified 4
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • facetStats attribute Added
POST /indexes/{indexUid}/documents
  • Query
  • primaryKey, csvDelimiter query parameters Added
POST /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • facetStats attribute Added
PUT /indexes/{indexUid}/documents
  • Query
  • primaryKey, csvDelimiter query parameters Added
Added 2
GET /metrics
POST /multi-search

Documentation content has changed

0.30.0

API structure has changed

7 structure changes including:
3 Additions
4 Modifications
Modified 4 Breaking
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • offset, limit, estimatedTotalHits attributes Modified
    • page, hitsPerPage, totalHits, totalPages attributes Added
  • Query
  • page, hitsPerPage query parameters Added
GET /tasks
  • Response
  • 200 response Modified
    • results attribute Modified
  • Query
  • indexUid, status, type query parameters Removed
  • uids, indexUids, statuses, types, canceledBy, beforeEnqueuedAt, afterEnqueuedAt, beforeStartedAt, afterStartedAt, beforeFinishedAt, afterFinishedAt query parameters Added
GET /tasks/:taskUid
  • Response
  • 200 response Modified
    • details, error attributes Modified
    • canceledBy attribute Added
  • Path
  • taskUid path parameter Added
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • page, hitsPerPage attributes Added
  • Response
  • 200 response Modified
    • offset, limit, estimatedTotalHits attributes Modified
    • page, hitsPerPage, totalHits, totalPages attributes Added
Added 3
DELETE /tasks
POST /swap-indexes
POST /tasks/cancel
0.29.0

API structure has changed

36 structure changes including:
36 Modifications
Modified 36 Breaking
DELETE /indexes/{indexUid}
  • Response
  • 204 response Removed
  • 202 response Added
DELETE /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/documents/{documentId}
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/faceting
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/pagination
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
DELETE /indexes/{indexUid}/settings/typo-tolerance
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
GET /indexes/{indexUid}/search
  • Query
  • matchingStrategy query parameter Added
GET /tasks
  • Response
  • 200 response Modified
    • results attribute Modified
GET /tasks/:taskUid
  • Response
  • 200 response Modified
    • batchUid attribute Removed
PATCH /indexes/{indexUid}
  • Response
  • 200 response Removed
  • 202 response Added
PATCH /indexes/{indexUid}/settings
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PATCH /indexes/{indexUid}/settings/faceting
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PATCH /indexes/{indexUid}/settings/pagination
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PATCH /indexes/{indexUid}/settings/typo-tolerance
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
POST /indexes
  • Response
  • 201 response Removed
  • 202 response Added
POST /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
POST /indexes/{indexUid}/documents/delete-batch
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • matchingStrategy attribute Added
PUT /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
PUT /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed attributes Removed
0.28.0

API structure has changed

50 structure changes including:
15 Breaking changes
6 Additions
41 Modifications
3 Removals
Modified 41 Breaking
DELETE /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/documents/{documentId}
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
DELETE /indexes/{indexUid}/settings/typo-tolerance
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
GET /indexes
  • Response
  • 200 response Modified
    • uid, name, primaryKey, createdAt, updatedAt, Additional properties are NOT allowed attributes Removed
    • results, limit, offset, total attributes Added
  • Query
  • limit, offset query parameters Added
GET /indexes/{indexUid}
  • Response
  • 200 response Modified
    • name attribute Removed
GET /indexes/{indexUid}/documents
  • Response
  • 200 response Modified
    • Additional properties are allowed attribute Removed
    • results, limit, offset, total attributes Added
  • Query
  • attributesToRetrieve query parameter Removed
  • fields query parameter Added
GET /indexes/{indexUid}/documents/{documentId}
  • Query
  • fields query parameter Added
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • hits attribute Modified
    • nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes Removed
    • estimatedTotalHits, facetDistribution attributes Added
  • Query
  • facetsDistribution, matches query parameters Removed
  • facets, showMatchesPosition query parameters Added
GET /indexes/{indexUid}/settings
  • Response
  • 200 response Modified
    • pagination, faceting attributes Added
GET /keys
  • Response
  • 200 response Modified
    • results attribute Modified
    • limit, offset, total attributes Added
  • Query
  • limit, offset query parameters Added
GET /keys/{uid_or_key}
  • Response
  • 200 response Modified
    • uid, name attributes Added
  • Path
  • uidOrKey path parameter Added
GET /tasks
  • Response
  • 200 response Modified
    • results attribute Modified
    • limit, from, next attributes Added
  • Query
  • limit, from, indexUid, status, type query parameters Added
GET /tasks/:taskUid
  • Response
  • 200 response Modified
    • details attribute Modified
PATCH /indexes/{indexUid}
  • Response
  • 200 response Modified
    • name attribute Removed
PATCH /indexes/{indexUid}/settings
  • Body
  • content type Modified
    • pagination, faceting attributes Added
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PATCH /indexes/{indexUid}/settings/typo-tolerance
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PATCH /keys/{uid_or_key}
  • Body
  • content type Modified
    • key, actions, indexes, expiresAt, createdAt, updatedAt attributes Removed
    • name, Additional properties are NOT allowed attributes Added
  • Response
  • 200 response Modified
    • uid, name attributes Added
POST /dumps
  • Response
  • 202 response Modified
    • content type Modified
POST /indexes
  • Response
  • 201 response Modified
    • name attribute Removed
POST /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
POST /indexes/{indexUid}/documents/delete-batch
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • matches, facetsDistribution attributes Removed
    • showMatchesPosition, facets attributes Added
  • Response
  • 200 response Modified
    • hits attribute Modified
    • nbHits, exhaustiveNbHits, facetsDistribution, exhaustiveFacetsCount attributes Removed
    • estimatedTotalHits, facetDistribution attributes Added
POST /keys
  • Body
  • content type Modified
    • uid, name attributes Added
  • Response
  • 200 response Modified
    • uid, name attributes Added
PUT /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
PUT /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • uid attribute Removed
    • taskUid, type attributes Added
Removed 3 Breaking
GET /dumps/{dumpUid}/status
GET /indexes/{indexUid}/tasks
GET /indexes/{indexUid}/tasks/{taskUid}
Added 6
DELETE /indexes/{indexUid}/settings/faceting
DELETE /indexes/{indexUid}/settings/pagination
GET /indexes/{indexUid}/settings/faceting
GET /indexes/{indexUid}/settings/pagination
PATCH /indexes/{indexUid}/settings/faceting
PATCH /indexes/{indexUid}/settings/pagination
0.27.0

API structure has changed

11 structure changes including:
3 Additions
8 Modifications
Modified 8
GET /indexes/{indexUid}/search
  • Query
  • highlightPreTag, highlightPostTag, cropMarker query parameters Added
GET /indexes/{indexUid}/settings
  • Response
  • 200 response Modified
    • typoTolerance attribute Added
GET /indexes/{indexUid}/tasks
  • Response
  • 200 response Modified
    • results attribute Modified
GET /indexes/{indexUid}/tasks/{taskUid}
  • Response
  • 200 response Modified
    • details attribute Modified
GET /tasks
  • Response
  • 200 response Modified
    • results attribute Modified
GET /tasks/:taskUid
  • Response
  • 200 response Modified
    • details attribute Modified
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • highlightPreTag, highlightPostTag, cropMarker attributes Added
POST /indexes/{indexUid}/settings
  • Body
  • content type Modified
    • typoTolerance attribute Added
Added 3
DELETE /indexes/{indexUid}/settings/typo-tolerance
GET /indexes/{indexUid}/settings/typo-tolerance
POST /indexes/{indexUid}/settings/typo-tolerance
0.26.0

API structure has changed

4 structure changes including:
4 Modifications
Modified 4
GET /indexes/{indexUid}/tasks
  • Response
  • 200 response Modified
    • results attribute Modified
GET /indexes/{indexUid}/tasks/{taskUid}
  • Response
  • 200 response Modified
    • batchUid attribute Added
GET /tasks
  • Response
  • 200 response Modified
    • results attribute Modified
GET /tasks/:taskUid
  • Response
  • 200 response Modified
    • batchUid attribute Added

Documentation content has changed

Documentation content has changed

0.25.0

API structure has changed

57 structure changes including:
3 Breaking changes
8 Additions
47 Modifications
2 Removals
Modified 47 Breaking
DELETE /indexes/{indexUid}
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/documents/{documentId}
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
DELETE /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
GET /dumps/{dumpUid}/status
  • Authentication
  • Api key authentication method Modified
GET /indexes
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/documents
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/documents/{documentId}
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/search
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/displayed-attributes
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/distinct-attribute
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/filterable-attributes
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/ranking-rules
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/searchable-attributes
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/sortable-attributes
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/stop-words
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/settings/synonyms
  • Authentication
  • Api key authentication method Modified
GET /indexes/{indexUid}/stats
  • Authentication
  • Api key authentication method Modified
GET /keys/{key}
  • Response
  • 200 response Modified
    • private, public, Additional properties are NOT allowed attributes Removed
    • key, actions, indexes, description, expiresAt, createdAt, updatedAt attributes Added
  • 401 response Removed
  • Authentication
  • Api key authentication method Modified
GET /stats
  • Authentication
  • Api key authentication method Modified
GET /version
  • Authentication
  • Api key authentication method Added
POST /dumps
  • Authentication
  • Api key authentication method Modified
POST /indexes
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/documents/delete-batch
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/search
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/stop-words
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
POST /indexes/{indexUid}/settings/synonyms
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
PUT /indexes/{indexUid}
  • Authentication
  • Api key authentication method Modified
PUT /indexes/{indexUid}/documents
  • Response
  • 202 response Modified
    • updateId attribute Removed
    • uid, indexUid, status, enqueuedAt attributes Added
  • Authentication
  • Api key authentication method Modified
Removed 2 Breaking
GET /indexes/{indexUid}/updates
GET /indexes/{indexUid}/updates/{updateId}
Added 8
DELETE /keys/{key}
GET /indexes/{indexUid}/tasks
GET /indexes/{indexUid}/tasks/{taskUid}
GET /keys
GET /tasks
GET /tasks/:taskUid
PATCH /keys/{key}
POST /keys/{key}
0.24.0

API structure has changed

49 structure changes including:
49 Modifications
Modified 49 Breaking
DELETE /indexes/{indexUid}
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/documents
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/documents/{documentId}
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/stop-words
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
DELETE /indexes/{indexUid}/settings/synonyms
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /dumps/{dumpUid}/status
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
  • 404 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/documents
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/documents/{documentId}
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/search
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/stop-words
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/settings/synonyms
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/stats
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/updates
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /indexes/{indexUid}/updates/{updateId}
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /keys
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /stats
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
GET /version
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /dumps
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes
  • Response
  • 400 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/documents
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
  • 413 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/documents/delete-batch
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/search
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/displayed-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/distinct-attribute
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/filterable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/ranking-rules
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/searchable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/sortable-attributes
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/stop-words
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
POST /indexes/{indexUid}/settings/synonyms
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
PUT /indexes/{indexUid}
  • Response
  • 400 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
PUT /indexes/{indexUid}/documents
  • Response
  • 401 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added
  • 413 response Modified
    • errorCode, errorType, errorLink attributes Removed
    • code, type, link attributes Added

Documentation content has changed

API structure has changed

16 structure changes including:
16 Modifications
Modified 16
GET /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • hits attribute Modified
POST /indexes
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/documents
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/documents/delete-batch
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/search
  • Response
  • 200 response Modified
    • hits attribute Modified
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/displayed-attributes
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/distinct-attribute
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/filterable-attributes
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/ranking-rules
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/searchable-attributes
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/sortable-attributes
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/stop-words
  • Header
  • Content-Type header Added
POST /indexes/{indexUid}/settings/synonyms
  • Header
  • Content-Type header Added
PUT /indexes/{indexUid}
  • Header
  • Content-Type header Added
PUT /indexes/{indexUid}/documents
  • Header
  • Content-Type header Added
0.22.0

API structure has changed

7 structure changes including:
3 Additions
4 Modifications
Modified 4
GET /indexes/{indexUid}/search
  • Query
  • sort query parameter Added
GET /indexes/{indexUid}/settings
  • Response
  • 200 response Modified
    • sortableAttributes attribute Added
POST /indexes/{indexUid}/search
  • Body
  • content type Modified
    • sort attribute Added
POST /indexes/{indexUid}/settings
  • Body
  • content type Modified
    • sortableAttributes attribute Added
Added 3
DELETE /indexes/{indexUid}/settings/sortable-attributes
GET /indexes/{indexUid}/settings/sortable-attributes
POST /indexes/{indexUid}/settings/sortable-attributes