Skip to main content This page is an exhaustive list of Meilisearch API errors.
api_key_already_existsA key with this uid
api_key_not_foundThe requested API key could not be found.
bad_requestThe request is invalid, check the error message for more information.
batch_not_foundThe requested batch does not exist. Please ensure that you are using the correct uid
database_size_limit_reachedThe requested database has reached its maximum size.
document_fields_limit_reachedA document exceeds the maximum limit of 65,535 fields .
document_not_foundThe requested document can’t be retrieved. Either it doesn’t exist, or the database was left in an inconsistent state.
dump_process_failedAn error occurred during the dump creation process. The task was aborted.
facet_search_disabledThe /facet-searchthe facetSearch index setting is set to false.
feature_not_enabledYou have tried using an experimental feature without activating it.
immutable_api_key_actionsThe actions
immutable_api_key_created_atThe createdAt
immutable_api_key_expires_atThe expiresAt
immutable_api_key_indexesThe indexes
immutable_api_key_keyThe key
immutable_api_key_uidThe uid
immutable_api_key_updated_atThe updatedAt
immutable_index_uidThe uid
immutable_index_updated_atThe updatedAt
immutable_webhookYou tried to modify a reserved webhook . Reserved webhooks are configured by Meilisearch Cloud and have isEditable set to true. Webhooks created with an instance option are also immutable.
immutable_webhook_uuidYou tried to manually set a webhook uuid. Meilisearch automatically generates uuid for webhooks.
immutable_webhook_is_editableYou tried to manually set a webhook’s isEditable field. Meilisearch automatically sets isEditable for all webhooks. Only reserved webhooks have isEditable set to false.
index_already_existsAn index with this uidindex creation .
index_creation_failedAn error occurred while trying to create an index, check out our guide on index creation .
index_not_foundAn index with this uid was not found, check out our guide on index creation .
index_primary_key_already_existsThe requested index already has a primary key that cannot be changed .
index_primary_key_multiple_candidates_foundPrimary key inference failed because the received documents contain multiple fields ending with id. Use the update index endpoint to manually set a primary key.internalMeilisearch experienced an internal error. Check the error message, and open an issue if necessary.
invalid_api_keyThe requested resources are protected with an API key. The provided API key is invalid. Read more about it in our security tutorial .
invalid_api_key_actionsThe actions
invalid_api_key_descriptionThe descriptionnull.
invalid_api_key_expires_atThe expiresAtRFC 3339 format or be set to null.
invalid_api_key_indexesThe indexes
invalid_api_key_limitThe limit
invalid_api_key_nameThe given namenull.
invalid_api_key_offsetThe offset
invalid_api_key_uidThe given uiduid must follow the uuid v4 format.
invalid_search_attributes_to_search_onThe value passed to attributesToSearchOnattributesToSearchOn accepts an array of strings indicating document attributes. Attributes given to attributesToSearchOn must be present in the searchableAttributes list
The value passed to media
The search query contains non-null values for both mediavectormedia generates vector embeddings via the embedder configured in hybrid.
invalid_content_typeThe Content-Type header is not supported by Meilisearch. Currently, Meilisearch only supports JSON, CSV, and NDJSON.
invalid_document_csv_delimiterThe csvDelimitera single ASCII character .
invalid_document_idThe provided document identifier does not meet the format requirements. A document identifier must be of type integer or string, composed only of alphanumeric characters (a-z A-Z 0-9), hyphens (-), and underscores (_).
invalid_document_fieldsThe fields
invalid_document_filterThis error occurs if:
invalid_document_limitThe limit
invalid_document_offsetThe offset
invalid_document_sortThis error occurs if:
The syntax for the sort
The attribute used for sorting is not defined in the sortableAttributessort ranking rule is missing from the settings
A reserved keyword like _geo, _geoDistance, _geoRadius, or _geoBoundingBox is used as a filter
invalid_document_geo_fieldThe provided _geo field of one or more documents is invalid. Meilisearch expects _geo to be an object with two fields, lat and lng, each containing geographic coordinates expressed as a string or floating point number. Read more about _geo and how to troubleshoot it in our dedicated guide .
invalid_document_geojson_fieldThe geojson field in one or more documents is invalid or doesn’t match the GeoJSON specification .
invalid_export_urlThe export target instance URL is invalid or could not be reached.
invalid_export_api_keyThe supplied security key does not have the required permissions to access the target instance.
invalid_export_payload_sizeThe provided payload size is invalid. The payload size must be a string indicating the maximum payload size in a human-readable format.
invalid_export_indexes_patternsThe provided index pattern is invalid. The index pattern must be an alphanumeric string, optionally including a wildcard.
invalid_export_index_filterThe provided index export filter is not a valid filter expression .
invalid_facet_search_facet_nameThe attribute used for the facetName field is either not a string or not defined in the filterableAttributes list
invalid_facet_search_facet_queryThe provided value for facetQuery is invalid. It should either be a string or null.
invalid_index_limitThe limit
invalid_index_offsetThe offset
invalid_index_uidThere is an error in the provided index format, check out our guide on index creation .
invalid_index_primary_keyThe primaryKeynull.
invalid_multi_search_query_federatedA multi-search query includes federationOptions but the top-level federation object is null or missing.
A multi-search query contains page, hitsPerPage, limit or offset, but the top-level federation object is not null.
invalid_multi_search_query_positionfederationOptions.queryPosition is not a positive integer.invalid_multi_search_weightA multi-search query contains a negative value for federated.weight.
invalid_multi_search_queries_ranking_rulesTwo or more queries in a multi-search request have incompatible results.
invalid_multi_search_facetsfederation.facetsByIndex.<INDEX_NAME> contains a value that is not in the filterable attributes list.invalid_multi_search_sort_facet_values_byfederation.mergeFacets.sortFacetValuesBy is not a string or doesn’t have one of the allowed values.invalid_multi_search_query_facetsA query in the queries array contains facets when federation is present and non-null.
invalid_multi_search_merge_facetsfederation.mergeFacets is not an object or contains unexpected fields.invalid_multi_search_max_values_per_facetfederation.mergeFacets.maxValuesPerFacet is not a positive integer.invalid_multi_search_facet_orderTwo or more indexes have a different faceting.sortFacetValuesBy for the same requested facet.
invalid_multi_search_facets_by_indexfacetsByIndex is not an object or contains unknown fields.invalid_multi_search_remotefederationOptions.remote is not network.self and is not a key in network.remotes.invalid_network_selfThe network object contains a self that is not a string or null.
invalid_network_remotesThe network object contains a remotes that is not an object or null.
invalid_network_urlOne of the remotes in the network object contains a url that is not a string.
invalid_network_search_api_keyOne of the remotes in the network object contains a searchApiKey that is not a string or null.
invalid_search_attributes_to_cropThe attributesToCropnull.
invalid_search_attributes_to_highlightThe attributesToHighlightnull.
invalid_search_attributes_to_retrieveThe attributesToRetrievenull.
invalid_search_crop_lengthThe cropLength
invalid_search_crop_markerThe cropMarkernull.
invalid_search_embedderembedderinvalid_search_facetsThis error occurs if:
The facetsnull
The attribute used for faceting is not defined in the filterableAttributes list
invalid_search_filterThis error occurs if:
The syntax for the filter
The attribute used for filtering is not defined in the filterableAttributes list
A reserved keyword like _geo, _geoDistance, or _geoPoint is used as a filter
invalid_search_highlight_post_tagThe highlightPostTag
invalid_search_highlight_pre_tagThe highlightPreTag
invalid_search_hits_per_pageThe hitsPerPage
invalid_search_hybrid_queryThe hybridnull nor an object, or it is an object with unknown keys.
invalid_search_limitThe limit
invalid_search_localesThe locales
invalid_settings_embedderThe embedders
invalid_settings_facet_searchThe facetSearch
invalid_settings_localized_attributesThe localizedAttributes
invalid_search_matching_strategyThe matchingStrategylast or all.
invalid_search_offsetThe offset
invalid_settings_prefix_searchThe prefixSearch
invalid_search_pageThe page
invalid_search_qThe qnull
invalid_search_ranking_score_thresholdThe rankingScoreThreshold0.0 and 1.0.
invalid_search_show_matches_positionThe showMatchesPositionnull.
invalid_search_sortThis error occurs if:
The syntax for the sort
The attribute used for sorting is not defined in the sortableAttributessort ranking rule is missing from the settings
A reserved keyword like _geo, _geoDistance, _geoRadius, or _geoBoundingBox is used as a filter
invalid_settings_displayed_attributesThe value of displayed attributes is invalid. It should be an empty array, an array of strings, or set to null.
invalid_settings_distinct_attributeThe value of distinct attributes is invalid. It should be a string or set to null.
invalid_settings_faceting_sort_facet_values_byThe value provided for the sortFacetValuesByalpha or count.
invalid_settings_faceting_max_values_per_facetThe value for the maxValuesPerFacetnull.
invalid_settings_filterable_attributesThe value of filterable attributes is invalid. It should be an empty array, an array of strings, or set to null.
The value for the maxTotalHitsnull.
invalid_settings_ranking_rulesThis error occurs if:
The settings payload has an invalid format
A non-existent ranking rule is specified
A custom ranking rule is malformed
A reserved keyword like _geo, _geoDistance, _geoRadius, _geoBoundingBox, or _geoPoint is used as a custom ranking rule
invalid_settings_searchable_attributesThe value of searchable attributes is invalid. It should be an empty array, an array of strings or set to null.
invalid_settings_search_cutoff_msThe specified value for `searchCutoffMs is invalid. It should be an integer indicating the cutoff in milliseconds.
invalid_settings_sortable_attributesThe value of sortable attributes is invalid. It should be an empty array, an array of strings or set to null.
invalid_settings_stop_wordsThe value of stop words is invalid. It should be an empty array, an array of strings or set to null.
invalid_settings_synonymsThe value of the synonyms is invalid. It should either be an object or set to null.
invalid_settings_typo_toleranceThis error occurs if:
The enablednull
The disableOnAttributesnull
The disableOnWordsnull
The minWordSizeForTyposnull
The value of either oneTypotwoTyposnull
invalid_similar_idThe provided target document identifier is invalid. A document identifier can be of type integer or string, only composed of alphanumeric characters (a-z A-Z 0-9), hyphens (-) and underscores (_).
not_found_similar_idMeilisearch could not find the target document. Make sure your target document identifier corresponds to a document in your index.
invalid_similar_attributes_to_retrieveattributesToRetrieveinvalid_similar_embedderembedderinvalid_similar_filterfilterMeilisearch also throws this error if the attribute used for filtering is not defined in the filterableAttributes list.
invalid_similar_limitlimitinvalid_similar_offsetoffsetinvalid_similar_show_ranking_scoreranking_scoreinvalid_similar_show_ranking_score_detailsranking_score_detailsinvalid_similar_ranking_score_thresholdThe rankingScoreThreshold0.0 and 1.0.
invalid_stateThe database is in an invalid state. Deleting the database and re-indexing should solve the problem.
invalid_store_fileThe data.ms folder is in an invalid state. Your b file is corrupted or the data.ms folder has been replaced by a file.
invalid_swap_duplicate_index_foundThe indexes used in the indexesswap index request have been declared multiple times. You must declare each index only once.
invalid_swap_indexesThis error happens if:
The payload doesn’t contain exactly two index uids
The payload contains an invalid index name in the indexes
invalid_task_after_enqueued_atThe afterEnqueuedAt
invalid_task_after_finished_atThe afterFinishedAt
invalid_task_after_started_atThe afterStartedAt
invalid_task_before_enqueued_atThe beforeEnqueuedAt
invalid_task_before_finished_atThe beforeFinishedAt
invalid_task_before_started_atThe beforeStartedAt
invalid_task_canceled_byThe canceledByuids should be separated by commas (,).
invalid_task_index_uidsThe indexUids
invalid_task_limitThe limit
invalid_task_statusesThe requested task status is invalid. Please use one of the possible values .
invalid_task_typesThe requested task type is invalid. Please use one of the possible values .
invalid_task_uidsThe uids
invalid_webhooksThe create webhook request did not contain a valid JSON payload. Meilisearch also returns this error when you try to create more than 20 webhooks.
invalid_webhook_urlThe provided webhook URL isn’t a valid JSON string, is null, is missing, or its value cannot be parsed as a valid URL.
The provided webhook headers field is not a JSON object or not a valid HTTP header. Meilisearch also returns this error if you set more than 200 header fields for a single webhook.
invalid_webhook_uuidThe provided webhook uuid is not a valid uuid v4 value.
io_errorThis error generally occurs when the host system has no space left on the device or when the database doesn’t have read or write access.
index_primary_key_no_candidate_foundPrimary key inference failed as the received documents do not contain any fields ending with id. Manually designate the primary key , or add some field ending with id to your documents.The Content-Type header does not match the request body payload format or the format is invalid.
missing_api_key_actionsThe actions
missing_api_key_expires_atThe expiresAt
missing_api_key_indexesThe indexes
This error happens if:
The requested resources are protected with an API key that was not provided in the request header. Check our security tutorial for more information
You are using the wrong authorization header for your version. v0.24 and below use X-MEILI-API-KEY: apiKey, whereas v0.25 and above use Authorization: Bearer apiKey
missing_content_typeThe payload does not contain a Content-Type header . Currently, Meilisearch only supports JSON, CSV, and NDJSON.
missing_document_filterThis payload is missing the filter
missing_document_idA document does not contain any value for the required primary key, and is thus invalid. Check documents in the current addition for the invalid ones.
missing_index_uidThe payload is missing the uid
missing_facet_search_facet_nameThe facetName
missing_master_keyYou need to set a master key before you can access the /keys route. Read more about setting a master key at launch in our security tutorial .
missing_network_urlOne of the remotes in the network object does not contain the url field.
missing_payloadThe Content-Type header was specified, but no request body was sent to the server or the request body is empty.
missing_swap_indexesThe index swap payload is missing the indexes
missing_task_filtersThe cancel tasks and delete tasks endpoints require one of the available query parameters.
no_space_left_on_deviceThis error occurs if:
The host system partition reaches its maximum capacity and can no longer accept writes
The tasks queue reaches its limit and can no longer accept writes. You can delete tasks using the delete tasks endpoint to continue write operations
not_foundThe requested resources could not be found.
payload_too_largeThe payload sent to the server was too large. Check out this guide to customize the maximum payload size accepted by Meilisearch.
task_not_foundThe requested task does not exist. Please ensure that you are using the correct uid
too_many_open_filesIndexing a large batch of documents, such as a JSON file over 3.5GB in size, can result in Meilisearch opening too many file descriptors. Depending on your machine, this might reach your system’s default resource usage limits and trigger the too_many_open_files error. Use ulimitulimit -Sn 3000 in a UNIX environment to raise the number of allowed open file descriptors to 3000.
too_many_search_requestsYou have reached the limit of concurrent search requests. You may configure it by relaunching your instance and setting a higher value to --experimental-search-queue-size
unretrievable_documentThe document exists in store, but there was an error retrieving it. This probably comes from an inconsistent state in the database.
vector_embedding_errorError while generating embeddings. You may often see this error when the embedding provider service is currently unavailable. Most providers offer status pages to monitor the state of their services, such as OpenAI’s https://status.openai.com/ .
Inaccessible embedding provider errors usually include a message stating Meilisearch “could not reach embedding server”.
Remote federated search errors remote_bad_responseThe remote instance answered with a response that this instance could not use as a federated search response.
remote_bad_requestThe remote instance answered with 400 BAD REQUEST.
remote_could_not_send_requestThere was an error while sending the remote federated search request.
remote_invalid_api_keyThe remote instance answered with 403 FORBIDDEN or 401 UNAUTHORIZED to this instance’s request. The configured search API key is either missing, invalid, or lacks the required search permission.
remote_remote_errorThe remote instance answered with 500 INTERNAL ERROR.
remote_timeoutThe proxy did not answer in the allocated time.
webhook_not_foundThe provided webhook uuid does not correspond to any configured webhooks in the instance. 
