Bild verkleinern API

Bild verkleinern API, verbindet BildKlein den Job mit deiner eigenen App: Du sendest die Datei, fragst den Job-Status ab und lädst das Ergebnis herunter. Die Endpunkte laufen auf dem Server – ganz ohne Browser.

Schnellstart

Erstelle einen Schlüssel im Bereich Entwickler-API deines Kontos; der Klartext-Schlüssel wird nur bei der Erstellung angezeigt.
Sende die Anfrage an https://api.pixepi.com mit dem Header Authorization: Bearer <key>.
Frage den Job aus der Antwort über GET https://api.pixepi.com/api/v1/jobs/{id} ab; sobald der Status done ist, lade das Ergebnis von der download_url herunter.

Beispielanfrage

curl -X POST "https://api.pixepi.com/api/v1/apps/gorsel-kucult/run" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -F "[email protected]" \
  -F "options[quality]=82" \
  -F "options[format]=same"

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/jobs/42"

Endpunkte dieses Werkzeugs

Methode	Pfad	Funktion
`POST`	`/run`	Führt das Werkzeug aus, startet einen Job und gibt das Ergebnis zurück.

Optionen

Optionen werden als options[<field>] gesendet; bleibt ein Feld leer, wird der Standardwert verwendet.

Feld	Werte	Standard
`options[quality]` Qualität	40–95	`82`
`options[max_side]` Limit für lange Kante (optional)	0–6000	`leer`
`options[format]` Ausgabeformat	same · jpeg · webp · png	`same`
`options[auto_rotate]` Foto-Ausrichtung automatisch korrigieren	aktiviert · deaktiviert	`aktiviert`

Gemeinsame Endpunkte

Methode	Pfad	Funktion
`GET`	`/api/v1/apps`	API-Katalog
`GET`	`/api/v1/apps/gorsel-kucult`	Werkzeug-Vertrag
`GET`	`/api/v1/jobs/{id}`	Job-Status
`GET`	`/api/v1/jobs/{id}/download`	Job-Ergebnis herunterladen
`GET`	`/api/v1/usage`	Nutzungsübersicht
`GET`	`/api/v1/openapi.json`	OpenAPI-3.1-Dokument

Limits

Maximal 100 MB pro Datei.
Stapelverarbeitung: Sende dasselbe Feld file mehrfach.
Kontingent- und Tarifinformationen sind an dein Konto gebunden; prüfe den aktuellen Status mit GET /api/v1/usage.

Fehlercodes

Code	Bedeutung
`unauthorized`	Der API-Schlüssel fehlt oder ist ungültig.
`forbidden`	Dieser Vorgang ist mit diesem Schlüssel nicht erlaubt.
`not_found`	Werkzeug, Job oder Datensatz nicht gefunden (404 auch bei kontoübergreifendem Zugriff).
`invalid_input`	Eingabe ungültig (fehlendes oder fehlerhaftes Feld, ungültiges Datum usw.).
`invalid_request`	Die Anfrage ist fehlerhaft.
`too_large`	Datei oder Anfrage übersteigt das Limit.
`unsupported_media`	Dateityp wird nicht unterstützt.
`not_supported`	Dieses Werkzeug kann auf diesem Endpunkt nicht ausgeführt werden (stateful App).
`not_ready`	Der Job ist noch nicht fertig.
`expired`	Das Ergebnis ist abgelaufen.
`no_output`	Für diesen Job ist kein Download verfügbar.
`invalid_path`	Ungültiger Ausgabepfad.
`quota_exceeded`	Kontingent oder Anfragelimit überschritten.
`rate_limited`	Zu viele Anfragen in kurzer Zeit. Warte kurz und versuche es erneut.
`csrf`	Formularüberprüfung im Browser fehlgeschlagen (die externe API nutzt Schlüssel).
`conflict`	Der Vorgang steht in Konflikt mit dem aktuellen Status.
`unavailable`	Das Werkzeug ist vorübergehend nicht verfügbar.
`internal_error`	Unerwarteter Serverfehler.

Dokumente

Häufig gestellte Fragen

Woher bekomme ich einen API-Schlüssel?

Erstelle einen Schlüssel im Bereich Entwickler-API deines Kontos. Der Schlüssel wird nur einmalig bei der Erstellung angezeigt.

Wie wird eine Anfrage gesendet?

Die Endpunkte laufen unter https://api.pixepi.com; jede Anfrage enthält den Header "Authorization: Bearer <key>".

Welche Dateien akzeptiert die BildKlein-API?

Unterstützte Formate: JPG · JPEG · PNG · WEBP. Das Limit liegt bei 100 MB pro Datei; die Optionen entsprechen denen auf der Werkzeug-Seite.

Wie lese ich eine Fehlerantwort?

Der Fehler-Body enthält die Felder {ok:false, error, code, request_id}; die Code-Werte findest du in der Fehlercode-Tabelle.