API References

    TIP

    Check out for answers to some common questions 💡

    Content Type

    Every request and response body is in .

    It is not required to have Content-Type: application/json in the header. Any content-type is accepted.

    Authentication

    For almost all routes, you need to be recognized by the server to check your permissions. Add your API key to your headers.
    Please read about authentication keys and for more information.

    X-Meili-API-Key: $API_KEY

    Success

    201 - Created: The resource has been created (synchronous)

    202 - Accepted: The update has been pushed in the update queue (asynchronous)

    204 - No Content: The resource has been deleted or no content has been returned

    205 - Reset Content: All the resources have been deleted

    Error

    400 - Bad Request: The request was unacceptable, often due to missing a required parameter.

    401 - Unauthorized: No valid API key provided.

    404 - Not Found: The requested resource doesn’t exist.

    All errors contain a body that explains the error.

    Response body:

    If you’re having trouble understanding an error, take a look at the complete list (opens new window) of errorCode values and descriptions.

    MeiliSearch is an asynchronous API. It means that, in a lot of cases, you will receive as server response a simple JSON with only an updateId attribute:

    2.   "updateId": 2
    3. }

    This successful response indicates that the operation has been queued or is currently executing.
    You can check the status of the operation via the and the .