API Documentation

Compress images programmatically using the TinyCompress REST API. Free tier: 50 requests/day per API key. Free

Authentication

Include your API key in every request via the X-API-Key header:

X-API-Key: tc_your_api_key_here

Base URL

https://urlshortner.jonoshad.top

Endpoints

POST/api/compress

Compress a PNG, JPEG, or WebP image and receive a download URL.

Parameter	Type	Required	Description
image	file	Yes	Image file (PNG, JPEG, WebP, max 10MB)

Example Request (curl):

curl -X POST https://urlshortner.jonoshad.top/api/compress \
  -H "X-API-Key: tc_your_key_here" \
  -F "image=@/path/to/photo.jpg"

Success Response (200):

{
  "success": true,
  "original_size": 204800,
  "compressed_size": 102400,
  "saved_bytes": 102400,
  "saved_percent": 50.0,
  "original_human": "200 KB",
  "compressed_human": "100 KB",
  "output_name": "photo_tiny.jpg",
  "download_url": "https://urlshortner.jonoshad.top/download.php?file=photo_tiny.jpg",
  "quota_remaining": 49
}

GET/api/status

Check your API quota remaining for today.

curl "https://urlshortner.jonoshad.top/api/status" \
  -H "X-API-Key: tc_your_key_here"

Response:

{
  "success": true,
  "quota_limit": 50,
  "used_today": 5,
  "remaining": 45,
  "reset_at": "2026-06-09 23:59:59"
}

POST/api/register

Parameter	Type	Required	Description
name	string	Yes	Your name
email	string	Yes	Your email address

Error Codes

HTTP Code	Meaning
200	Success
400	Bad request (missing or invalid parameters)
401	Missing API key
403	Invalid or revoked API key
413	File too large
415	Unsupported file type
429	Rate limit or daily quota exceeded
500	Compression failed (server error)
503	API disabled

← Back to Home • Get API Key