Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting wunderdocs support.

Status codes

Here is a list of the different categories of status codes returned by the wunderdocs API. Use these to understand if a request was successful.

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description
    A 4xx status code indicates a client error
  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the wunderdocs API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the wunderdocs API — use these to understand what you have done wrong.

  • Name
    api_error
    Type
    Description

    This means that we made an error, which is highly speculative and unlikely.

  • Name
    invalid_request
    Type
    Description

    This means it is a client error.

Error response

{
  "status": 500,
  "error": "api_error",
  "message": "Internal Server Error"
}

429 Too Many Requests

If you are making too many requests to the wunderdocs API, you will receive a 429 Too Many Requests error. This error is returned when you have exceeded the free tier or the rate limit for your account.

To solve this error you should upgrade your account to a paid version. If you are already on a paid plan, you should contact support.

Error response

{
  "status": 429,
  "error": "invalid_request",
  "message": "Too Many Requests"
}

429 Free Tier Limit Exceeded

You have exceeded the free tier for your account.

To solve this error you should upgrade your account to a paid version. If you are already on a paid plan, you should contact support.

Error response

{
  "status": 429,
  "error": "invalid_request",
  "message": "freeTierLimitExceeded"
}