Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and let's be honest, 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 reaching out to support with an error, please be aware that the vast majority of reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting our support team.
Status codes
Here is a list of the different categories of status codes returned by the ELAN AI Bridge API. Use these to understand if a request was successful.
- Name
2xx- Description
A 2xx status code indicates a successful response.
- Name
4xx- Description
A 4xx status code indicates a client error — this means it's a you problem.
- Name
5xx- Description
A 5xx status code indicates a server error — we try our best to avoid these, but sometimes they happen. They are typically on us.
Error types
Whenever a request is unsuccessful, the ELAN AI Bridge API will return an error response with an error description. 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.
Error response
{
"detail": "Failed to get glossary: Glossary 1 not found for organization rbr...rMi"
}