api_key_already_exists

api_key_already_exists

This page is an exhaustive list of Meilisearch API errors.

`api_key_already_exists`

A key with this uid already exists.

`api_key_not_found`

The requested API key could not be found.

`bad_parameter`

A parameter in the request is invalid, check the error message for more information. This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`bad_request`

The request is invalid, check the error message for more information.

`batch_not_found`

The requested batch does not exist. Please ensure that you are using the correct uid.

`chat_not_found`

No chat is configured for the specified workspace UID.

`database_size_limit_reached`

The requested database has reached its maximum size.

`document_not_found`

The requested document cannot be retrieved because it does not exist.

`dump_already_processing`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`dump_not_found`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`dump_process_failed`

An error occurred during the dump creation process. The task was aborted.

`duplicate_index_found`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`dynamic_search_rule_not_found`

This error occurs when the provided uid does not correspond to any configured dynamic search rule.

`edit_documents_by_function_error`

Could not compile the provided function as RHAI code.

`facet_search_disabled`

The /facet-search route has been queried while the facetSearch index setting is set to false.

`feature_not_enabled`

You have tried using an experimental feature without activating it.

`immutable_api_key_actions`

The actions field of an API key cannot be modified.

`immutable_api_key_created_at`

The createdAt field of an API key cannot be modified.

`immutable_api_key_expires_at`

The expiresAt field of an API key cannot be modified.

`immutable_api_key_indexes`

The indexes field of an API key cannot be modified.

`immutable_api_key_key`

The key field of an API key cannot be modified.

`immutable_api_key_uid`

The uid field of an API key cannot be modified.

`immutable_api_key_updated_at`

The updatedAt field of an API key cannot be modified.

`immutable_index_created_at`

The createdAt field of an index cannot be modified.

`immutable_index_updated_at`

The updatedAt field of an index cannot be modified.

`immutable_webhook`

You tried to modify a reserved webhook. Reserved webhooks are configured by Meilisearch Cloud and have isEditable set to false. Webhooks created with an instance option are also immutable.

`immutable_webhook_is_editable`

You tried to manually set a webhook’s isEditable field. Meilisearch automatically sets isEditable for all webhooks. Only reserved webhooks have isEditable set to false.

`immutable_webhook_uuid`

You tried to manually set a webhook uuid. Meilisearch automatically generates uuid for webhooks.

`import_task_already_received`

The proposed import task has already been received by this remote. This error occurs when a cluster of Meilisearch instances are rebalancing their documents, and an exporting instance re-exports the same documents multiple times for some reason (reboot, etc).

`import_task_unknown_remote`

The proposed import task refers to a remote that is unknown to this Meilisearch instance. This error occurs when a cluster of Meilisearch instances are rebalancing their documents, and an exporting instance exports its documents using a remote name that is unexpected to this Meilisearch instance. Check the network configuration.

`import_task_without_network_task`

The proposed import task was received by an instance that is not in the middle of rebalancing its documents. This error occurs when a cluster of Meilisearch instances are rebalancing their documents, and an exporting instance exports its documents to an unsuspecting remote. Check the network configuration.

`inconsistent_document_change_headers`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`index_already_exists`

An index with this uid already exists, check out our guide on index creation.

`index_creation_failed`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`index_not_found`

An index with this uid was not found, check out our guide on index creation.

`index_primary_key_already_exists`

The requested index already has a primary key that cannot be changed.

`index_primary_key_multiple_candidates_found`

Primary key inference failed because the received documents contain multiple fields ending with id. Use the update index endpoint to manually set a primary key.

`index_primary_key_no_candidate_found`

Primary 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.

`index_scoped_api_key_with_global_action`

This error occurs when calling an endpoint that requires a global API key with an API key that is scoped to a subset of indexes. Call the endpoint with an API key that has “indexes”: [“*”]

`internal`

Meilisearch experienced an internal error. Check the error message, and open an issue if necessary.

`invalid_api_key`

The 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_actions`

The actions field for the provided API key resource is invalid. It should be an array of strings representing action names.

`invalid_api_key_description`

The description field for the provided API key resource is invalid. It should either be a string or set to null.

`invalid_api_key_expires_at`

The expiresAt field for the provided API key resource is invalid. It should either show a future date or datetime in the RFC 3339 format or be set to null.

`invalid_api_key_indexes`

The indexes field for the provided API key resource is invalid. It should be an array of strings representing index names.

`invalid_api_key_limit`

The limit parameter is invalid. It should be an integer.

`invalid_api_key_name`

The given name is invalid. It should either be a string or set to null.

`invalid_api_key_offset`

The offset parameter is invalid. It should be an integer.

`invalid_api_key_uid`

The given uid is invalid. The uid must follow the uuid v4 format.

`invalid_batch_uids`

The batchUids parameter is invalid. It must be an array of positive integers.

`invalid_chat_completion_api_key`

Invalid apiKey parameter. It should be a string.

`invalid_chat_completion_api_version`

Invalid API version for the chat completion. It should be a string.

`invalid_chat_completion_base_api`

Invalid baseUrl parameter. It should be a valid URL to an LLM provider.

`invalid_chat_completion_deployment_id`

Invalid deploymentId parameter.

`invalid_chat_completion_org_id`

Invalid orgId parameter.

`invalid_chat_completion_pre_query_prompt`

This error code is no longer emitted by Meilisearch.

`invalid_chat_completion_project_id`

Invalid projectId parameter.

`invalid_chat_completion_prompts`

This error code is no longer emitted by Meilisearch.

`invalid_chat_completion_search_description_prompt`

Invalid searchDescription parameter. It should be a string.

`invalid_chat_completion_search_filter_param_prompt`

Invalid searchFilterParam parameter. It should be a string.

`invalid_chat_completion_search_index_uid_param_prompt`

Invalid searchIndexUidParam parameter. It should be a string.

`invalid_chat_completion_search_query_param_prompt`

Invalid searchQParam parameter. It should be a string.

`invalid_chat_completion_source`

This error code is no longer emitted by Meilisearch.

`invalid_chat_completion_system_prompt`

Invalid system prompt. It should be a string.

`invalid_chat_setting_document_template`

Rendering a document using the document template configured in the chat settings for this index failed. Make sure that the configured document template can render any document from the index.

`invalid_content_type`

The Content-Type header is not supported by Meilisearch.

For document additions, Meilisearch supports JSON, CSV and NDJSON.
For other routes, Meilisearch expects JSON content.

`invalid_document_csv_delimiter`

The csvDelimiter parameter is invalid. It should either be a string or a single ASCII character.

`invalid_document_edition_context`

The context parameter is not an object.

`invalid_document_edition_function_filter`

The filter parameter is not a valid Meilisearch filter.

`invalid_document_fields`

The fields parameter is invalid. It should be a string.

`invalid_document_filter`

This error occurs if:

The filter parameter is invalid
It should be a string, array of strings, or array of array of strings for the get documents with POST endpoint
It should be a string for the get documents with GET endpoint
The attribute used for filtering is not defined in the filterableAttributes list
The filter expression has a missing or invalid operator. Read more about our supported operators

`invalid_document_geo_field`

The 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_field`

The geojson field in one or more documents is invalid or doesn’t match the GeoJSON specification.

`invalid_document_id`

The 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_ids`

The ids parameter is invalid. It should be an array of valid document ids.

`invalid_document_limit`

The limit parameter is invalid. It should be an integer.

`invalid_document_offset`

The offset parameter is invalid. It should be an integer.

`invalid_document_retrieve`

This error code is no longer emitted and can be found in tasks imported from a dump created using a previous version of Meilisearch.

`invalid_document_retrieve_vectors`

The retrieveVectors parameter is invalid. It should be a boolean.

`invalid_document_sort`

This error occurs if:

The syntax for the sort parameter is invalid
The attribute used for sorting is not defined in the sortableAttributes list or the sort ranking rule is missing from the settings
A reserved keyword like _geo, _geoDistance, _geoRadius, or _geoBoundingBox is used as a filter

`invalid_document_use_network`

The useNetwork parameter is invalid. It should be a boolean.

`invalid_dynamic_search_rule_actions`

The actions parameter is invalid.

`invalid_dynamic_search_rule_active`

The active parameter is invalid. It should be a boolean.

`invalid_dynamic_search_rule_conditions`

The conditions parameter is invalid.

`invalid_dynamic_search_rule_description`

The description parameter is invalid. It should be a string.

`invalid_dynamic_search_rule_filter`

The filter parameter is invalid.

`invalid_dynamic_search_rule_filter_active`

The filter.active parameter is invalid. It should be a boolean

`invalid_dynamic_search_rule_filter_query`

The filter.query parameter is invalid. It should be a string.

`invalid_dynamic_search_rule_limit`

The limit parameter is invalid. It should be a positive integer.

`invalid_dynamic_search_rule_offset`

The offset parameter is invalid. It should be a positive integer.

`invalid_dynamic_search_rule_priority`

The precedence parameter is invalid. It should be a positive number

`invalid_dynamic_search_rule_uid`

The uid path parameter is invalid.

`invalid_export_api_key`

The supplied security key does not have the required permissions to access the target instance.

`invalid_export_index_filter`

The provided index export filter is not a valid filter expression.

`invalid_export_index_override_settings`

The indexes[].overrideSettings parameter is invalid. It should be a boolean.

`invalid_export_indexes_patterns`

The provided index pattern is invalid. The index pattern must be an alphanumeric string, optionally including a wildcard.

`invalid_export_payload_size`

The provided payload size is invalid. The payload size must be a string indicating the maximum payload size in a human-readable format.

`invalid_export_url`

The export target instance URL is invalid or could not be reached. If the target instance URL is in your private network, please check that it resolves to an IP in an allowed range.

`invalid_facet_search_exhaustive_facet_count`

The exhaustiveFacetCount parameter is invalid. It should be a boolean.

`invalid_facet_search_facet_name`

The attribute used for the facetName field is either not a string or not defined in the filterableAttributes list.

`invalid_facet_search_name`

This error code is no longer emitted by Meilisearch.

`invalid_facet_search_query`

The provided value for facetQuery is invalid. It should either be a string or null.

`invalid_header_value`

A header from this request has an unexpected value.

`invalid_index_custom_metadata`

The customMetadata query parameter is invalid. It should be a string.

`invalid_index_fields_filter`

Invalid filter parameter.

`invalid_index_fields_filter_attribute_patterns`

Invalid filter.attributePatterns parameter. It should be an array of strings.

`invalid_index_fields_filter_displayed`

Invalid filter.displayed parameter. It should be a boolean.

`invalid_index_fields_filter_distinct`

Invalid filter.distinct parameter. It should be a boolean.

`invalid_index_fields_filter_filterable`

Invalid filter.filterable parameter. It should be a boolean.

`invalid_index_fields_filter_ranking_rule`

Invalid filter.rankingRule parameter. It should be a boolean.

`invalid_index_fields_filter_searchable`

Invalid filter.searchable parameter. It should be a boolean.

`invalid_index_fields_filter_sortable`

Invalid filter.sortable parameter. It should be a boolean.

`invalid_index_limit`

The limit parameter is invalid. It should be an integer.

`invalid_index_offset`

The offset parameter is invalid. It should be an integer.

`invalid_index_primary_key`

The primaryKey field is invalid. It should either be a string or set to null.

`invalid_index_uid`

There is an error in the provided index format, check out our guide on index creation.

`invalid_multi_search_distinct`

This error occurs when both federation.distinct and the distinct parameter of a query are specified. Remove one of these parameters.

`invalid_multi_search_facet_order`

Two or more indexes have a different faceting.sortFacetValuesBy for the same requested facet.

`invalid_multi_search_facets`

federation.facetsByIndex.<INDEX_NAME> contains a value that is not in the filterable attributes list.

`invalid_multi_search_facets_by_index`

facetsByIndex is not an object or contains unknown fields.

`invalid_multi_search_federated`

The federation parameter is invalid. It should either be an object or set to null.

`invalid_multi_search_federation_options`

This error occurs when a query inside of a federated search specifies both useNetwork and a non-null federationOptions.remote. Remove one of these parameters.

`invalid_multi_search_max_values_per_facet`

federation.mergeFacets.maxValuesPerFacet is not a positive integer.

`invalid_multi_search_merge_facets`

federation.mergeFacets is not an object or contains unexpected fields.

`invalid_multi_search_query_facets`

A query in the queries array contains facets when federation is present and non-null.

`invalid_multi_search_query_pagination`

A multi-search query contains page, hitsPerPage, limit or offset, but the top-level federation object is not null.

`invalid_multi_search_query_personalization`

Using .personalize is not allowed in federated queries.

`invalid_multi_search_query_position`

federationOptions.queryPosition is not a positive integer.

`invalid_multi_search_query_ranking_rules`

Two or more queries in a multi-search request have incompatible results.

`invalid_multi_search_query_show_performance_details`

showPerformanceDetails was used at the search query level in a federated search. Use federation.showPerformanceDetails in federated search requests.

`invalid_multi_search_remote`

federationOptions.remote is not network.self and is not a key in network.remotes.

`invalid_multi_search_weight`

A multi-search query contains a negative value for federated.weight.

`invalid_network_leader`

The error occurs if:

The leader parameter is not a string.
The specified leader is not part of the declared remotes.
The specified leader is not self.

`invalid_network_remotes`

The network object contains a remotes that is not an object or null.

`invalid_network_search_api_key`

One of the remotes in the network object contains a searchApiKey that is not a string or null.

`invalid_network_self`

The network object contains a self that is not a string or null.

`invalid_network_shards`

This error occurs if:

The shards parameter is invalid. It must be an object or null.
The shards parameter contains at least one shard referencing an undeclared remote.
The shards parameter contains at least one shard referencing no remotes.

`invalid_network_url`

One of the remotes in the network object contains a url that is not a string.

`invalid_network_write_api_key`

One of the remotes in the network object contains a writeApiKey that is not a string or null.

`invalid_render_input`

The input parameter is invalid.

`invalid_render_template`

The template parameter is invalid.

`invalid_s_3_snapshot_parameters`

Invalid S3 snapshot configuration

`invalid_s_3_snapshot_request`

This Meilisearch instance sent a bad S3 snapshot request.

`invalid_search_attributes_to_crop`

The attributesToCrop parameter is invalid. It should be an array of strings, a string, or set to null.

`invalid_search_attributes_to_highlight`

The attributesToHighlight parameter is invalid. It should be an array of strings, a string, or set to null.

`invalid_search_attributes_to_retrieve`

The attributesToRetrieve parameter is invalid. It should be an array of strings, a string, or set to null.

`invalid_search_attributes_to_search_on`

The value passed to attributesToSearchOn is invalid. attributesToSearchOn accepts an array of strings indicating document attributes. Attributes given to attributesToSearchOn must be present in the searchableAttributes list.

`invalid_search_crop_length`

The cropLength parameter is invalid. It should be an integer.

`invalid_search_crop_marker`

The cropMarker parameter is invalid. It should be a string or set to null.

`invalid_search_distinct`

This error occurs if:

distinct is not a string.
The selected distinct attribute is not a filterable attribute.

`invalid_search_embedder`

embedder is invalid. It should be a string corresponding to the name of a configured embedder.

`invalid_search_facets`

This error occurs if:

The facets parameter is invalid. It should be an array of strings, a string, or set to null
The attribute used for faceting is not defined in the filterableAttributes list

`invalid_search_filter`

This error occurs if:

The syntax for the filter parameter is invalid
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_tag`

The highlightPostTag parameter is invalid. It should be a string.

`invalid_search_highlight_pre_tag`

The highlightPreTag parameter is invalid. It should be a string.

`invalid_search_hits_per_page`

The hitsPerPage parameter is invalid. It should be an integer.

`invalid_search_hybrid_query`

The hybrid parameter is neither null nor an object, or it is an object with unknown keys.

`invalid_search_limit`

The limit parameter is invalid. It should be an integer.

`invalid_search_locales`

The locales parameter is invalid.

`invalid_search_matching_strategy`

The matchingStrategy parameter is invalid. It should either be set to last or all.

`invalid_search_media`

The value passed to media is not a valid JSON object.

`invalid_search_media_and_vector`

The search query contains non-null values for both media and vector. These two parameters are mutually exclusive, since media generates vector embeddings via the embedder configured in hybrid.

`invalid_search_offset`

The offset parameter is invalid. It should be an integer.

`invalid_search_page`

The page parameter is invalid. It should be an integer.

`invalid_search_personalize`

personalize is not an object with the expected keys.

`invalid_search_personalize_user_context`

The personalizeUserContext query parameter is invalid. It should be a string

`invalid_search_q`

The q parameter is invalid. It should be a string or set to null

`invalid_search_ranking_score_threshold`

The rankingScoreThreshold in a search or multi-search request is not a number between 0.0 and 1.0.

`invalid_search_retrieve_vectors`

The retrieveVectors parameter is invalid. It should be a boolean.

`invalid_search_semantic_ratio`

The hybrid.semanticRatio parameter is invalid. It should be a number between 0.0 and 1.0

`invalid_search_show_matches_position`

The showMatchesPosition parameter is invalid. It should either be a boolean or set to null.

`invalid_search_show_performance_details`

showPerformanceDetails is invalid. It should be a boolean.

`invalid_search_show_ranking_score`

showRankingScore is invalid. It should be a boolean.

`invalid_search_show_ranking_score_details`

showRankingScoreDetails is invalid. It should be a boolean.

`invalid_search_sort`

This error occurs if:

The syntax for the sort parameter is invalid
The attribute used for sorting is not defined in the sortableAttributes list or the sort ranking rule is missing from the settings
A reserved keyword like _geo, _geoDistance, _geoRadius, or _geoBoundingBox is used as a filter

`invalid_search_use_network`

useNetwork is invalid. It should be a boolean.

`invalid_search_vector`

The vector parameter is invalid. It should be an array of numbers.

`invalid_settings_dictionary`

The value of the dictionary is invalid.

`invalid_settings_displayed_attributes`

The value of displayed attributes is invalid. It should be an empty array, an array of strings, or set to null.

`invalid_settings_distinct_attribute`

The value of distinct attributes is invalid. It should be a string or set to null.

`invalid_settings_embedders`

The embedders index setting value is invalid.

`invalid_settings_facet_search`

The facetSearch index setting value is invalid.

`invalid_settings_faceting`

The faceting index setting is invalid.

`invalid_settings_filterable_attributes`

The value of filterable attributes is invalid. It should be an empty array, an array of strings, or set to null.

`invalid_settings_foreign_keys`

The value of foreign keys is invalid.

`invalid_settings_index_chat`

The chat index settings are invalid.

`invalid_settings_localized_attributes`

The localizedAttributes index setting value is invalid.

`invalid_settings_non_separator_tokens`

The value of [non-separator tokens](https://www.

（本文超出站点单文档体积上限，已截断）

​ api_key_already_exists

​ api_key_already_exists