Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. 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 CUFinder support.
Status Codes
Here is a list of the different categories of status codes returned by the CUFinder API. Use these to understand if a request was successful.
- 200
indicates a successful response.
- 400
indicates a not enough credits.
- 401
indicates an invalid API key.
- 404
indicates a not found results (Our algorithm can't find a data for your query).
- 422
indicates an error in sending data.
- 500
indicates a server error — you won't be seeing these
Error types
Whenever a request is unsuccessful, the CUFinder 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 CUFinder API — use these to understand what you have done wrong.
api_error
stringThis means that we made an error, which is highly speculative and unlikely.
invalid_request
stringThis means that you made an error, which is much more likely.
{
"type": "api_error",
"message": "API key is wrong!"
}