> ## Documentation Index
> Fetch the complete documentation index at: https://docs.intelliprint.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Errors

> The Intelliprint API returns errors in a standardised format.

When an error occurs, the Intelliprint API always returns a standardised JSON object describing the error.

```json Example Error Response theme={null}
{
  "error": {
    "message": "Received unknown parameter: confimred (Did you mean confirmed?)",
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "param": "confimred",
  }
}
```

The SDKs automatically parse errors and provide native error objects for each error type.
You can find SDK-specific error handling examples along with each SDK's documentation.

## Understanding the Error Object

#### `message`

This is a friendly human-readable description of the error.

#### `type`

This is the general category of the error. This can be one of the following:

| Type                    | Description                                                                                                                                           |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `invalid_request_error` | A parameter provided in the request was invalid, missing, or unknown. The `param` field will contain the name of the parameter that caused the error. |
| `authentication_error`  | The API key provided was invalid or missing.                                                                                                          |
| `payment_error`         | The account doesn't have adequate balance to cover the cost of the print job or has maxed out their credit limit.                                     |
| `rate_limited`          | The IP address has exceeded the rate limit.                                                                                                           |
| `internal_error`        | An internal server error occurred on Intelliprint's side.                                                                                             |
| `network_error`         | This is only triggered by the SDKs when they are unable to connect to the Intelliprint API.                                                           |

#### `code`

This is a unique code for the specific error that occurred. This can be one of the following:

| Error Code              | Description                                                                                                                      |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `parameter_invalid`     | The value provided for a parameter was invalid.                                                                                  |
| `parameter_missing`     | A required parameter was missing from the request.                                                                               |
| `parameter_unknown`     | An unknown parameter was provided in the request.                                                                                |
| `body_too_large`        | The request body was too large (> 100 MiB).                                                                                      |
| `body_incorrect_format` | The request body was incorrectly formatted (e.g. not a valid JSON object and not a multipart/form-data request).                 |
| `no_api_key`            | No API key was provided in the request.                                                                                          |
| `invalid_api_key`       | The API key provided was invalid or expired.                                                                                     |
| `payment_error`         | The account doesn't have adequate balance to cover the cost of the print job or has maxed out their credit limit.                |
| `not_found`             | The requested resource was not found.                                                                                            |
| `rate_limited`          | The IP address has exceeded the rate limit.                                                                                      |
| `internal_error`        | An internal server error occurred on Intelliprint's side.                                                                        |
| `network_error`         | This is only triggered by the SDKs when they are unable to connect to the Intelliprint API.                                      |
| `forbidden`             | The API key provided was not authorised to access the requested resource.                                                        |
| `refused`               | The request was refused by the server. This is only triggered when the account has reached its limit for the requested resource. |

#### `param`

This is the parameter that caused the error, if applicable. This can be unset if the error is not related to a specific parameter.

### Getting Help

If you need help, there are many resources available to you:

1. The [API Reference](/api) contains detailed information about each endpoint and its parameters.
2. The [Get Started](/) guide has examples of how to use the API.
3. The [Intelliprint Support](mailto:hello@intelliprint.net) team is always happy to help. Just email us with:
   * The full error message and code.
   * The request that caused the error.
   * The print job ID (if applicable).