Errors

Errors

When something is wrong with the request due to a problem with authentication, the API will respond with a 400 status code (this means that something went wrong on the client side) and a meaningful message describing why the error occurred.

API Key not provided

If the API key is not provided in the request header. The API is going to raise a bad request 400 error.

header = {
	"content-type": "application/json"
}

<Response [404]>
{'detail': 'API Key was not provided in the request header.'}

Invalid API Key

If the provided key in the header does not match the allowed/expected format, the bad request error is also going to be thrown.

header = {
	"X-API-Key": "testing"
	"content-type": "application/json"
}

<Response [404]>
{'detail': 'Invalid API Key was provided in the request header.'}

User connected with the API Key not found

The last type of error might happen when the provided API key does not match with any of the user projects on the platform.

header = {	
	"X-API-Key": "<YOUR-API-KEY-HERE>",
	"content-type": "application/json"
}

<Response [404]>
{'detail': 'X-API-Key header invalid'}