errors.yaml

---
errors:
  - code: index_creation_failed
    description: "An error occurred while trying to create an index, check out our guide on [index creation](https://docs.meilisearch.com/learn/core_concepts/indexes.html)."
  - code: index_already_exists
    description: "An index with this UID already exists, check out our guide on [index creation](https://docs.meilisearch.com/learn/core_concepts/indexes.html)."
  - code: index_not_found
    description: "An index with this UID was not found, check out our guide on [index creation](https://docs.meilisearch.com/learn/core_concepts/indexes.html)."
  - code: invalid_index_uid
    description: "There is an error in the provided index format, check out our guide on [index creation](https://docs.meilisearch.com/learn/core_concepts/indexes.html)."
  - code: index_not_accessible
    description: "An internal error occurred while trying to access the requested index."
  - code: invalid_state
    description: "The database is in an invalid state. Deleting the database and re-indexing should solve the problem."
  - code: primary_key_inference_failed 
    description: "The first provided document contains no fields with the substring `id`. [Manually designate the primary key](https://docs.meilisearch.com/learn/core_concepts/documents.md#setting-the-primary-key) or add `id` to one of your fields so it can be used as the primary key during inference. We recommend manually setting the primary key."
  - code: document_fields_limit_reached
    description: "A document exceeds the maximum limit of 65,535 fields."
  - code: missing_document_id
    description: "A 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."
  - code: invalid_document_id
    description: "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 (_)."
  - code: invalid_filter
    description: "The filter provided with the search is invalid. This may be due to syntax errors in the `filter` parameter, using reserved fields as filter expressions, or neglecting to add the filtering attributes to `filterableAttributes`. For troubleshooting, check our [guide on filtering](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html)."
  - code: invalid_sort
    description: "The sort value is invalid. This may be due to syntax errors in the `sort` parameter, using reserved fields as sort expressions, or neglecting to add the sorting attributes to `sortableAttributes`. For troubleshooting, check our [guide on sorting](https://docs.meilisearch.com/reference/features/sorting.html)."
  - code: bad_request
    description: "The request is invalid, check the error message for more information."
  - code: document_not_found
    description: "The requested document can't be retrieved. Either it doesn't exist, or the database was left in an inconsistent state."
  - code: internal
    description: "MeiliSearch experienced an internal error. Check the error message, and open an issue if necessary."
  - code: missing_authorization_header
    description: "The requested resources are protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/reference/features/authentication.html) for more information."
  - code: not_found
    description: "The requested resources could not be found."
  - code: payload_too_large
    description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/reference/features/configuration.html#payload-limit-size) to customize the maximum payload size accepted by MeiliSearch."
  - code: unretrievable_document
    description: "The document exists in store, but there was an error retrieving it. This probably comes from an inconsistent state in the database."
  - code: invalid_content_type
    description: "The Content-Type header is not supported by MeiliSearch. Currently, MeiliSearch only supports JSON, CSV, and NDJSON."
  - code: missing_content_type
    description: "The payload does not contain a Content-Type header. Currently, MeiliSearch only supports JSON, CSV, and NDJSON."
  - code: malformed_payload  
    description: "The Content-Type header does not match the request body payload format or the format is invalid."
  - code: missing_payload
    description: "The Content-Type header was specified, but no request body was sent to the server or the request body is empty."  
  - code: dump_already_processing
    description: "Dump creation is already in progress. A new dump creation process can be triggered after the current one has been completed."
  - code: dump_not_found
    description: "The requested dump could not be found."  
  - code: dump_process_failed
    description: "An error occurred during dump creation process, task aborted."
  - code: invalid_ranking_rule
    description: "The provided ranking rules are invalid. This may be due to syntax errors in your ranking rules or specifying custom ranking rules on reserved fields or reserved expressions. For more information on ranking rule configuration, check our [relevancy guide](https://docs.meilisearch.com/learn/core_concepts/relevancy.html#ranking-rules)."
  - code: invalid_geo_field
    description: "The provided `_geo` field of one or more documents is invalid. Read more about `_geo` and how to troubleshoot it in [our dedicated guide](https://docs.meilisearch.com/reference/features/geosearch.html)."
  - code: invalid_api_key
    description: "The requested resources are protected with an API key. The provided API key is invalid. Read more about it at in our [dedicated guide](https://docs.meilisearch.com/reference/features/authentication.html)."
  - code: invalid_store_file
    description: "The `data.ms` folder is in an invalid state. Your `.mdb` file is corrupted or the `data.ms` folder has been replaced by a file."
  - code: no_space_left_on_device
    description: "The host system partition has reached its maximum capacity and can no longer accept writes." 
  - code: database_size_limit_reached
    description: "The requested database has reached its maximum size; no further documents can be added. For information on customizing the maximum database size accepted by MeiliSearch, check out this [guide](https://docs.meilisearch.com/reference/features/configuration.html#max-udb-size)."
  - code: index_primary_key_already_exists
    description: "The requested index already has a primary key that cannot be changed."
...