Bodia

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 went wrong and do some rudimentary debugging (before contacting support).

Before reaching out to our 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 Bodia support.

Status codes

Here is a list of the different categories of status codes returned by the Bodia API. Use them to understand if a request was successful.

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — this means it's a you problem.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — you won't be seeing those.

Error types

Whenever a request is unsuccessful, the Bodia API will return an error response with an error type and message. You can use this information to better understand what went 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 Bodia API — use these to understand what you have done wrong.

  • Name
    FineTuneNameMissing
    Type
    Description

    You haven't provided a Fine-Tune name, like man, woman, couple, dog, cat, pet, etc...

  • Name
    FineTuneImagesMissing
    Type
    Description

    Images are missing for fine-tuning. Add images URLs to images_url.

  • Name
    FineTuneImagesNotEnough
    Type
    Description

    There are not enough images for fine-tuning, minimum of 4 images.

  • Name
    PromptMissing
    Type
    Description

    The prompt is missing.

  • Name
    PromptDoesNotIncludeFineTuneName
    Type
    Description

    The prompt does not include Fine-Tune name to identify it in the prompt.

Error response

{
"status": 401,
"name": "Unauthorized",
"message": "You are not authorized to access this resource. Please provide a valid API key."
}