Bildoptimierungs-API-Endpunkt

Offizielle technische Dokumentation für den zentralen Bildverarbeitungs-Endpunkt POST /v1/optimize.

Der primäre Endpunkt zur Optimierung, Transkodierung, Herunterskalierung und Größenanpassung von Bildern lautet:

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

Anfrageformat (JSON-Payload)

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

Anfragetext-Schema

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  }}

Parameter	Typ	Erforderlich	Beschreibung
`filename`	string	Ja	Ursprünglicher Dateiname des Bildes (z. B. `banner.png`)
`mime_type`	string	Ja	MIME-Typ (z. B. `image/jpeg`, `image/png`, `image/webp`)
`filesize`	integer	Ja	Gesamte Dateigröße in Bytes (muss > 0 sein)
`options.format`	string	Nein	Zielformat: `avif`, `webp`, `original` / `keep`, `jpg`, `png` (Standard: `webp`)
`options.quality`	integer	Nein	Kompressionsqualität zwischen `1` und `100` (Standard: `80`)
`options.max_dimension`	integer	Nein	Proportionale Begrenzung der maximalen langen Kante in Pixeln (z. B. `1600`, `1920`, `2048`, `2560`)
`options.max_width`	integer	Nein	Begrenzung der maximalen Breite in Pixeln
`options.max_height`	integer	Nein	Begrenzung der maximalen Höhe in Pixeln
`options.lossless`	boolean	Nein	Pixelgenaue verlustfreie Kompression aktivieren (Standard: `false`)
`options.strip_metadata`	boolean	Nein	EXIF-Kameradaten und Farbprofile entfernen (Standard: `true`)

Parameter für direkte Bildtransformation

Direkte Cloud-Transformationsrouten akzeptieren URL-Abfrageparameter für sofortige Skalierung und Konvertierung:

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

Serverantwort (200 OK)

Nach erfolgreicher Initialisierung liefert SmallPict eine signierte Upload-URL sowie eine Auftrags-ID zurück:

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"}

Laden Sie die Bilddaten per HTTP-PUT an die upload_url hoch und fragen Sie anschließend den Auftragsstatus ab. Verwenden Sie den sicheren Upload-Link genau so, wie er zurückgegeben wird: Er läuft nach kurzer Zeit ab und gilt nur für diesen Upload.

Auftragsstatus abfragen

Prüfen Sie den Konvertierungsfortschritt mittels:

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

Antwort nach Abschluss (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"}