API Documentation

Integrate our powerful image optimization API into your application with just a few simple steps.

Authentication

All API requests must be authenticated. You can get your unique API key from your dashboard after signing up. Authenticate by providing your key in one of two ways:

As an X-API-Key header (recommended for server-side requests).
As an api_key URL query parameter (for simple GET requests).

Endpoints

Optimize from URL

POST https://syncnote.space/optimize

This is the standard endpoint for server-to-server communication. You send a JSON body with the image URL and options.

Optimize via File Upload

POST https://syncnote.space/optimize-upload

Use this endpoint to send an image file directly from a user upload or your server's file system.

Simple GET Request

GET https://syncnote.space/optimize

A simplified endpoint for quick tests or browser-based requests where all parameters are in the URL.

Request Examples

Example 1: cURL (Optimize from URL)


curl -X POST "https://syncnote.space/optimize" -H "Content-Type: application/json" -H "X-API-Key: YOUR_API_KEY" -d '{
  "image_url": "https://.../image.jpg",
  "quality": 80,
  "resize": {
    "width": 500
  }
}'

Example 2: Simple GET Request URL


https://syncnote.space/optimize?api_key=YOUR_API_KEY&image_url=https://.../image.jpg&quality=80