API Documentation
Comprehensive documentation for PicOptimize API endpoints, including authentication, rate limits, request/response examples, and integration guides.
API Endpoints
POST /api/compress
Public
Endpoint Details
- Description: Image compression and WebP conversion endpoint
- Method: POST
- Authentication: None (public endpoint)
- Rate Limit: 60 requests per minute per IP
Request Format (multipart/form-data)
files: Array of image files (PNG, JPG, WebP)options: JSON string with compression settings
Request Options
{
"quality": 0.8,
"resize": {
"width": 1200,
"height": 800
},
"format": "webp"
}Example Request (cURL)
curl -X POST https://picoptimize.com/api/compress \ -F "[email protected]" \ -F "[email protected]" \ -F 'options={"quality": 0.8, "resize": {"width": 1200}}'
Example Response (Success)
{
"success": true,
"compressedFiles": [
"https://picoptimize.com/compressed/image1.webp",
"https://picoptimize.com/compressed/image2.webp"
],
"processingTimeMs": 850,
"originalSize": "2.4 MB",
"compressedSize": "380 KB",
"savingsPercent": 84
}Error Responses
- 400 Bad Request: Invalid file types or missing parameters
- 413 Payload Too Large: Files exceeding size limits (max 50MB/file)
- 500 Internal Server Error: Server-side compression failure
- 501 Not Implemented: Server-side compression not available (current state)