API Errors
HTTP statuses and stable error codes returned by the Business API
Errors use Content-Type: application/problem+json:
{
"type": "about:blank",
"title": "Template not found",
"status": 404,
"detail": "The template was not found or is not accessible with this API key.",
"code": "TEMPLATE_NOT_FOUND",
"requestId": "6d70b49e-..."
}| HTTP | Code | Meaning |
|---|---|---|
| 400 | INVALID_JSON | The body is not valid JSON |
| 400 | INVALID_REQUEST | A required field is missing or invalid |
| 400 | INVALID_LAYOUT | The layout shape, fields, values, or start slot are invalid |
| 400 | IDEMPOTENCY_KEY_INVALID | The idempotency key is empty, too long, or contains spaces |
| 401 | AUTHORIZATION_REQUIRED | The Authorization header is missing |
| 401 | AUTHORIZATION_INVALID | The header does not use the Bearer scheme |
| 401 | API_KEY_INVALID | The key is invalid or inactive |
| 402 | INSUFFICIENT_CREDITS | The account does not have enough credits |
| 403 | BUSINESS_PLAN_REQUIRED | The account has no active Business subscription |
| 403 | SUBSCRIPTION_EXPIRED | The Business subscription period ended |
| 403 | API_TRIAL_EXPIRED | The one-time API trial period ended |
| 403 | API_TRIAL_LIMIT_REACHED | All 10 trial requests have been used |
| 404 | TEMPLATE_NOT_FOUND | The template does not exist or belongs to another account |
| 404 | LAYOUT_PRESET_NOT_FOUND | The requested Avery or APLI Print Layout preset does not exist |
| 409 | IDEMPOTENCY_KEY_REUSED | The same key was used with a different request body |
| 409 | IDEMPOTENCY_REQUEST_IN_PROGRESS | The first request using this key has not completed |
| 409 | IDEMPOTENCY_REPLAY_UNAVAILABLE | The template changed after the original successful request |
| 413 | REQUEST_TOO_LARGE | The JSON request body exceeds 1 MB |
| 422 | TEMPLATE_INVALID | The saved template cannot be rendered |
| 422 | API_TRIAL_SINGLE_PAGE_REQUIRED | The trial request would generate more than one page |
| 422 | BATCH_LIMIT_EXCEEDED | The request exceeds the record, output-item, or page limit |
| 422 | LAYOUT_SIZE_MISMATCH | The template dimensions do not match the selected preset |
| 422 | LAYOUT_OVERFLOW | The manual grid, margins, and gaps do not fit the selected paper |
| 429 | RATE_LIMIT_EXCEEDED | The key exceeded its per-minute limit |
| 500 | PDF_GENERATION_FAILED | Rendering failed after validation |
| 500 | INTERNAL_ERROR | An unexpected server error occurred |
| 503 | SERVICE_UNAVAILABLE | Authentication, subscription, or template storage is unavailable |
| 503 | BILLING_SERVICE_UNAVAILABLE | Credit lookup or consumption is unavailable |
Include the requestId when contacting technical support. Internal details and customer variables are not returned in error responses.
For retry guidance, see Limits and Billing.