/v1/compress - Compresto Documentation

Compress image

cURL

curl --request POST \
  --url https://api.compresto.app/v1/compress \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '\n{
  "image": "<string>",
  "url": "<string>",
  "quality": 80,
  "format": "auto",
  "maxWidth": 2,
  "maxHeight": 2
}\n'

Python

import requests

url = "https://api.compresto.app/v1/compress"

payload = {
    "image": "<string>",
    "url": "<string>",
    "quality": 80,
    "format": "auto",
    "maxWidth": 2,
    "maxHeight": 2
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript Fetch

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    image: '<string>',
    url: '<string>',
    quality: 80,
    format: 'auto',
    maxWidth: 2,
    maxHeight: 2
  })
};

fetch('https://api.compresto.app/v1/compress', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api.compresto.app/v1/compress",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "POST",\
  CURLOPT_POSTFIELDS => json_encode([\
    'image' => '<string>',\
    'url' => '<string>',\
    'quality' => 80,\
    'format' => 'auto',\
    'maxWidth' => 2,\
    'maxHeight' => 2\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "X-API-Key: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.compresto.app/v1/compress"

payload := strings.NewReader("{\n  \"image\": \"<string>\",\n  \"url\": \"<string>\",\n  \"quality\": 80,\n  \"format\": \"auto\",\n  \"maxWidth\": 2,\n  \"maxHeight\": 2\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.post("https://api.compresto.app/v1/compress")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"image\": \"<string>\",\n  \"url\": \"<string>\",\n  \"quality\": 80,\n  \"format\": \"auto\",\n  \"maxWidth\": 2,\n  \"maxHeight\": 2\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.compresto.app/v1/compress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"image\": \"<string>\",\n  \"url\": \"<string>\",\n  \"quality\": 80,\n  \"format\": \"auto\",\n  \"maxWidth\": 2,\n  \"maxHeight\": 2\n}"

response = http.request(request)
puts response.read_body

Example

"<string>"

Authorizations

X-API-Key
Type: string
In: header
Required
API key for authentication. Get your key at https://compresto.app/dashboard

Body

• image: Base64-encoded image (with or without data URI prefix)
• url: Public image URL (https)
• quality: Compression quality (1-100)
• format: Output format (default: auto)
• maxWidth: Maximum width in pixels (maintains aspect ratio)
• maxHeight: Maximum height in pixels (maintains aspect ratio)

Response

200

image/jpeg
Compressed image binary
The response is of type file.