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.

Overview

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).

Most API errors are caused by client-side issues. Please carefully check your request parameters, authentication, and API usage before reporting issues.

Status codes

Here is a list of the different categories of status codes returned by the Slateo 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 — you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Slateo 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 Slateo API — use these to understand what you have done wrong.

Name
api_error
Description
This means that we made an error, which is highly speculative and unlikely.
Name
invalid_request
Description
This means that you made an error, which is much more likely.

Error response

{
  "type": "api_error",
  "message": "No way this is happening!?",
  "documentation_url": "https://api-reference.slateo.ai/errors/api_error"
}

Troubleshooting

Getting 401 Unauthorized errors

If you receive a 401 error, your API key may be invalid or missing. Check that you're including the Authorization: Bearer {token} header in your request and that your API key is active.

Getting 404 Not Found errors

A 404 error means the resource you're trying to access doesn't exist. Verify the resource ID in your request URL is correct and that you have permission to access it.

Getting 429 Rate Limit errors

If you're hitting rate limits, reduce the frequency of your requests. Current limits are 1000 requests per hour per API key.

FAQ

What should I do if I get a 500 error?

While rare, 5xx errors indicate a server-side issue. If you encounter a persistent 500 error, please contact support with the request details and error message.

How can I debug invalid_request errors?

The error message will include details about what went wrong. Common causes include missing required parameters, invalid parameter values, or malformed JSON in the request body. Check the error message carefully for specific guidance.

Are there different rate limits for different endpoints?

Currently, all endpoints share the same rate limit of 1000 requests per hour per API key and 100 concurrent requests per organization. If you need higher limits, contact your account manager.