Zum Hauptinhalt springen
Diese Seite behandelt die Konventionen, die für jeden Endpoint gelten. Die vollständige, endpointweise Referenz — generiert aus der OpenAPI-Spezifikation der API — findest du in den Gruppen in der Seitenleiste: Bildgenerierung, Bildbearbeitung, Bildoperationen, Videogenerierung, Prompt-Verbesserung (demnächst verfügbar), Modelltraining, Modelle und Konto & Nutzung. Ein funktionierendes End-to-End-Beispiel findest du im Quickstart.

​
Basis-URL

​
Authentifizierung

Jede Anfrage muss einen organisationsweiten API key als Bearer-Token mitführen:
Keys gehören der Organisation, sind mit Scopes versehen und werden nur einmal bei der Erstellung angezeigt. Unter Einen API key erstellen erfährst du, wie du einen bekommst.

​
Konventionen

  • Asynchrone Jobs — Generierungs-Endpoints geben 202 Accepted mit einer Job-id zurück; frage den passenden GET-Endpoint nach dem Status ab oder gib eine webhook_url an, um bei Fertigstellung benachrichtigt zu werden.
  • Synchrone Aufrufe — die Prompt-Verbesserung (demnächst verfügbar) gibt ihr Ergebnis in der 200-Antwort zurück; es gibt keinen Job zum Abfragen. Sie akzeptiert einen optionalen Idempotency-Key-Header für sichere Wiederholungen.
  • Status — Jobs durchlaufen pending, processing und dann einen terminalen Status completed, failed oder cancelled.
  • Scopes — die meisten Endpoints benötigen einen Scope auf dem Key (zum Beispiel images.generate); GET /me braucht nur einen gültigen Key. Ein Key, dem ein erforderlicher Scope fehlt, erhält 403.
  • Fehler — Nicht-2xx-Antworten liefern einen strukturierten JSON-Fehlerkörper mit type, code, message und request_id.
  • Credits — Aktionen ziehen aus dem Credit-Pool der Organisation; ein aufgebrauchter Pool liefert 402.
  • Rate Limits — Anfragen sind pro Key begrenzt; wird das Limit überschritten, liefert die API 429 mit einem Retry-After-Header.