LogoLogoAPI-Dokumentation
LogoLogoAPI-Dokumentation
Startseite
ÜberblickAuthentifizierung und IdempotenzBildgenerierungBildbearbeitungBildkonvertierungJobs und begrenztes WartenCreditsFehlerRatenbegrenzung und ParallelitätAPI-Changelog
API-Dokumentation

Authentifizierung und Idempotenz

API-Schlüssel, Scopes, Request-IDs und sichere Wiederholungen

Bearer-Authentifizierung

Schlüssel legen Sie unter Einstellungen → API-Schlüssel an und widerrufen sie dort. Das Geheimnis wird nur ein einziges Mal angezeigt. Senden Sie es im Standard-Header:

Authorization: Bearer sd_YOUR_KEY

Akzeptiert wird ausschließlich der Authorization-Header. Zugangsdaten im Query-String und X-API-Key werden nicht unterstützt. Ein fehlender, ungültiger, abgelaufener oder widerrufener Schlüssel führt zu 401 UNAUTHORIZED. Ein gültiger Schlüssel ohne den Scope des Endpunkts führt zu 403 FORBIDDEN.

Scopes

ScopeErlaubt
images:generateGenerierungs-Jobs anlegen
images:editBearbeitungs-Jobs anlegen
images:convertKonvertierungs-Jobs anlegen
jobs:readJobs desselben Kontos lesen
credits:readAktuelles Guthaben lesen

Verwenden Sie pro Anwendung und Umgebung eigene, eingeschränkte Schlüssel. Das Widerrufen eines Schlüssels betrifft bereits angelegte Jobs des Kontos nicht.

Idempotenz

Alle drei POST-Endpunkte verlangen einen Idempotency-Key mit 8 bis 255 Zeichen. Wird derselbe Endpunkt mit demselben Schlüssel und derselben kanonischen Anfrage erneut aufgerufen, kommt der ursprüngliche Job zurück, ohne dass erneut Credits reserviert werden. Wird der Schlüssel mit anderem Inhalt wiederverwendet, folgt 409 IDEMPOTENCY_CONFLICT.

Bei Multipart-Anfragen gehören auch die Bytes des Quellbilds zur Identität. Das Bild auszutauschen und den Schlüssel beizubehalten ist deshalb ein Konflikt.

Request-IDs

Jede Antwort enthält X-Request-Id. Fehler-Bodies wiederholen sie als error.request_id. Request-IDs können bedenkenlos in Anwendungs-Logs gespeichert werden.

Überblick

SciDraw AI-Bildgenerierung, -bearbeitung und -konvertierung einbinden

Bildgenerierung

Jobs für Text-zu-Bild anlegen

Inhaltsverzeichnis

Bearer-Authentifizierung
Scopes
Idempotenz
Request-IDs