API Error Codes

Below is a comprehensive list of all possible error codes you might encounter when using the Poof API. Each error includes a description, HTTP status code, and a link to detailed documentation about how to handle it.

Error Reference Table

Error Code	Description	HTTP Status
authentication_error	Invalid or missing API key	401
permission_denied	Access to this resource is forbidden	403
payment_required	Insufficient credits or plan upgrade needed	402
rate_limit_exceeded	Too many requests	429
validation_error	Invalid request parameters	400
missing_image	No image file in request	400
image_too_large	Image exceeds size limit	400
upstream_error	Processing service failed	502
internal_server_error	Server error	500

Error Response Format

All errors follow a consistent JSON response format:

{
  "code": "error_code",
  "message": "Human-readable description",
  "details": "Additional context or troubleshooting steps",
  "request_id": "req_abc123xyz"
}

The request_id is useful for support — include it when contacting us about an issue.

Getting Started

API Reference

API Error Codes

Error Reference Table

Error Response Format

​Error Reference Table

​Error Response Format

Error Reference Table

Error Response Format