Introduction - Compresto Documentation
Base URL
https://api.compresto.app
Authentication
All API requests require an API key. Include your key in the X-API-Key header:
curl -H "X-API-Key: ck_your_api_key" https://api.compresto.app/v1/compress
Get your API key from the Compresto Dashboard.
Available Endpoints
POST /v1/compress \ \ Compress an image with quality and format options
GET /v1/usage \ \ Check your API usage statistics
Rate Limits
The API enforces per-user rate limits based on your subscription plan:
| Plan | Rate Limit | Monthly Quota |
|---|---|---|
| Free | 60 req/min | 500 requests |
| Pro | 60 req/min | 5,000 requests |
- Rate limits are enforced per user
- Monthly quotas reset on the 1st of each month
- Use the
/v1/usageendpoint to check your current usage
Response Codes
| Code | Description |
|---|---|
200 |
Success |
400 |
Bad request - invalid parameters |
401 |
Unauthorized - invalid or missing API key |
429 |
Rate limit exceeded (per-minute) or monthly quota exceeded |
500 |
Server error |
Support
Need help? Contact us at support@compresto.app or visit compresto.app.