Intelliprint
Browse docs

Technical

Errors

The Intelliprint API returns errors in a standardised format.

On this page

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

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

  1. The API Reference 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 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).