Punkt końcowy optymalizacji obrazów

Oficjalna dokumentacja techniczna dla głównego punktu końcowego POST /v1/optimize.

Główny punkt końcowy do optymalizacji, transkodowania, skalowania w dół i zmiany rozmiaru obrazów to:

POST https://api.smallpict.app/v1/optimize
(Alias: POST https://api.smallpict.app/v1/convert)

Format żądania (Ładunek JSON)

HTTP

POST /v1/optimize HTTP/1.1Host: api.smallpict.appX-API-Key: sp_sdk_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0bX-Timestamp: 1716301234X-Signature: 3a9f8b2c4d6e8a0f1b3c5d7e9f2a4b6c8d0e1f3a5b7c9d1e3f5a7b9c1d3e5f7aContent-Type: application/jsonIdempotency-Key: c9b8a7f6-e5d4-4c3b-2a1f-0e9d8c7b6a5f

Schemat treści żądania

JSON

{  "filename": "hero-banner.jpg",  "mime_type": "image/jpeg",  "filesize": 1654200,  "options": {    "format": "avif",    "quality": 80,    "max_dimension": 1600,    "max_width": 1920,    "max_height": 1080,    "lossless": false,    "strip_metadata": true  }}

Pole	Typ	Wymagane	Opis
`filename`	string	Tak	Oryginalna nazwa pliku obrazu (np. `banner.png`)
`mime_type`	string	Tak	Typ MIME (np. `image/jpeg`, `image/png`, `image/webp`)
`filesize`	integer	Tak	Całkowity rozmiar pliku w bajtach (musi być > 0)
`options.format`	string	Nie	Format docelowy: `avif`, `webp`, `original` / `keep`, `jpg`, `png` (Domyślnie: `webp`)
`options.quality`	integer	Nie	Jakość kompresji od `1` do `100` (Domyślnie: `80`)
`options.max_dimension`	integer	Nie	Proporcjonalne ograniczenie maksymalnego wymiaru dłuższego boku w pikselach (np. `1600`, `1920`, `2048`, `2560`)
`options.max_width`	integer	Nie	Ograniczenie maksymalnej szerokości w pikselach
`options.max_height`	integer	Nie	Ograniczenie maksymalnej wysokości w pikselach
`options.lossless`	boolean	Nie	Włącz bezstratną kompresję bit-w-bit (Domyślnie: `false`)
`options.strip_metadata`	boolean	Nie	Usuń dane EXIF aparatu i profile kolorów (Domyślnie: `true`)

Parametry bezpośredniej transformacji obrazu

Trasy transformatora chmurowego akceptują parametry URL do natychmiastowej zmiany rozmiaru i konwersji:

GET https://api.smallpict.app/v1/transform?url=...&format=webp&quality=80&max_dimension=1600

?format=avif|webp|original
?quality=1..100
?max_dimension=1600
?max_width=1920
?max_height=1080

Odpowiedź serwera (200 OK)

Po pomyślnej inicjalizacji SmallPict zwraca bezpieczny podpisany adres URL do przesłania oraz identyfikator zadania:

Response · 200 OK

{  "upload_url": "https://upload.smallpict.app/uploads/a1b2c3d4/hero-banner.jpg?signature=...",  "job_id": "job-a1b2c3d4",  "object_key": "uploads/a1b2c3d4/hero-banner.jpg",  "status": "queued"}

Prześlij bajty obrazu do upload_url żądaniem HTTP PUT, a następnie sprawdź status zadania. Używaj bezpiecznego linku do przesyłania dokładnie w takiej postaci, w jakiej został zwrócony: wygasa po krótkim czasie i działa tylko dla tego przesłania.

Sprawdzanie statusu zadania

Sprawdź postęp konwersji za pomocą zapytania:

GET https://api.smallpict.app/v1/optimize/status?job_id=job-a1b2c3d4

Odpowiedź po zakończeniu (200 OK)

Response · 200 OK

{  "job_id": "job-a1b2c3d4",  "status": "completed",  "url": "https://cdn.smallpict.app/opt/hero-banner.avif",  "format": "avif",  "bytes_saved": 1456200,  "savings_percentage": 88.03,  "created_at": "2026-08-23T08:00:00Z",  "updated_at": "2026-08-23T08:00:01Z"}