Errors

In this guide, we will talk about what happens when something goes wrong while you work with the Meshy API.

Meshy leverages conventional HTTP response codes to indicate the success or failure of an API request. Generally, codes in the 2xx range indicate success; codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was missing, an invalid model was provided, etc.); codes in the 5xx range indicate an internal error with Meshy's servers, which should be rare.

Status Codes

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

  • Name
    2xx
    Description

    A 2xx status code indicates a successful response.

    • Name
      200 - OK
      Description

      By default if everything worked as expected a 200 status code will be returned.

    • Name
      202 - Accepted
      Description

      Your request has been accepted for processing, but the processing has not been completed. This is a non-committal response from Meshy API. For example, a request to create a new Text to Texture task will return a 202 status code.

  • Name
    4xx
    Description

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

    • Name
      400 - Bad Request
      Description

      The request was unacceptable, often due to missing a mandatory parameter or one of the parameters was malformed.

    • Name
      401 - Unauthorized
      Description

      No valid API key provided or the API key provided is not authorized to access the Meshy API endpoint.

    • Name
      402 - Payment Required
      Description

      Insufficient funds in the account associated with the provided API key.

    • Name
      404 - Not Found
      Description

      The requested resource doesn't exist. For example, when you try to retrieve a task by its ID but provided an invalid ID, you will get a 404 status code.

    • Name
      429 - Too Many Requests
      Description

      Too many requests hit the Meshy API too quickly. Please refer to the Rate Limiting guide for details.

  • Name
    5xx
    Description

    A 5xx status code indicates a server error, we hope you won't be seeing these - but if you do, please contact us for help!

Error Response

Whenever a request is unsuccessful, the Meshy 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 should be helpful and actionable, they also share a common structure:

  • Name
    message
    Type
    string
    Description

    A short description message of the error.

Example Response with 400 - Bad Request status code

{
  "message": "Invalid model file extension: .3dm"
}