SimplyPNG/Documentation

SimplyPNG API Documentation

Remove backgrounds from images programmatically with our simple REST API.

Quick Start
Get up and running in 5 minutes with our step-by-step guide.
Authentication
Learn how to authenticate your API requests using API keys.
API Reference
Complete reference for all API endpoints, parameters, and responses.

Base URL

All API requests should be made to:

https://api.simplypng.app/api/v1

Features

  • Fast Processing - Most images processed in under 5 seconds
  • High Quality - AI-powered edge detection for clean results
  • Simple API - Just send an image, get a transparent PNG
  • Flexible Output - Get results as URL or base64
  • Idempotency - Prevent duplicate processing with idempotency keys
  • HEIC Support - Native support for iPhone photos (HEIC/HEIF)

Supported Image Formats

FormatExtensionsNotes
JPEG.jpg, .jpegMost common format
PNG.pngSupports transparency
WebP.webpModern web format
HEIC/HEIF.heic, .heifiPhone photos - fully supported

Image Input Methods

You can provide images in two ways:

Method 1: URL Input (Recommended)

Provide a public URL to your image. Best for large images and production use.

{
  "image": "https://your-storage.com/photo.jpg"
}
  • No size limit
  • Faster processing (no upload through API)
  • Works with any public URL (S3, R2, CloudFront, etc.)

Method 2: Base64 Input

Send image data directly as a base64-encoded string. Good for small images and quick tests.

{
  "image": "data:image/png;base64,iVBORw0KGgo..."
}
  • Maximum 4 MB (after decoding)
  • Convenient for small images
  • No external storage needed

Image Size Limits

Input TypeMax SizeBest For
URL (http/https)30 MBLarge images, production use, HEIC files
Base64 (data URL)4 MBSmall images, quick tests

๐Ÿ’ก Tip: For images larger than 4MB (like 4K photos or HEIC files), upload to any storage service and use URL input. This is also faster since the image doesn't pass through the API server.

Rate Limits

API Credit PackageRate Limit
Trial (free)10 requests/minute
Standard (500-24,999 credits)60 requests/minute
High Volume (25K+ credits)120 requests/minute
Enterprise300 requests/minute

Rate limits are based on your total API credits purchased, not subscription plan. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in all responses.

HD Mode

For higher quality results, enable HD mode by setting options.hd_mode: true:

{
  "image": "https://your-storage.com/photo.jpg",
  "options": { "hd_mode": true }
}
ModeCreditsBest For
Standard (default)1 credit/imageMost use cases, fast processing
HD Mode2 credits/imageProduct photos, professional quality