Errors

Errors

The Abyssale Generation API (synchronous or asynchronous) can return the following error codes :

Code
Description

400

A payload will be returned in the HTTP response explaining the error.

For instance, here are payloads returned:

  • If a given parameter is invalid (here the given color is invalid):

{"message": "body_validation_errors: {'media': {'text_role': ["The following property is invalid: ({'color': ['Must be an hexadecimal color. i.e. #EAEAEA']})."]}}", "errors": {"media": {"text_role": ["The following property is invalid: ({'color': ['Must be an hexadecimal color. i.e. #EAEAEA']})."]}}}

  • If a text cannot be inserted:

{"id": "cannot_build_banner", "message": "Element text_name error: The text 'Welcome to the Abyssale Developer Hub' cannot fit within the defined space."}

401 403

Unauthorized Ensure your API key is the right one.

404

Not Found The route (or the given template) cannot be found.

405

Method Not Allowed You tried to access Abyssale with an invalid method.

429

API Limits reached All of your image generation API calls are consumed: You should upgrade to a higher plan.

500

Internal Server Error Try again later: Contact us on help@abyssale.com if the error occurs.

HTTP Error 400: Details

Error
Description

Invalid Image

The given image cannot be identified. Only jpeg,png,webp,gif,tiff & svg files are allowed.

SVG security error

The provided SVG contains security issues. Please make sure that the version is at least 1.1 (you can also use the following tool to optimize your file: https://jakearchibald.github.io/svgomg/).

Large SVG error

The SVG file provided cannot be processed properly (either too large or too heavy). Please use another svg file or a rasterised image (png, jpeg, webp).

QR code not supported extension

The QRCode Icon filetype is not supported (supported types: png,jpeg,webp,tiff & gif)

Text too long

The text cannot fit within the defined space.

InvalidFont

The font does'nt exist

Button text too long

The text cannot fit within the defined space.

InvalidI ilustration

The illustration doesn't exist

Last updated