API-Doku

Überblick

Bild- und Videogenerierung direkt in dein eigenes Produkt holen.

Die API stellt genau das bereit, was auch das Studio nutzt: dieselben Modelle, dieselbe Preislogik, dieselbe Render-Kette. Was du im Browser erzeugen kannst, erzeugst du auch mit einem Schlüssel – und die Ergebnisse landen genauso in deiner Asset-Bibliothek.

Was möglich ist

Text / Bild zu BildReferenzbilder, Seitenverhältnisse und Qualitätsstufen 1K/2K/4K. Bis zu 4 Bilder pro Anfrage.
Text / Bild zu VideoErster und letzter Frame, Referenzbilder, mehrere Auflösungen. Die Länge wird auf die gewählte Stufe begrenzt.
ModellwahlJedes ausgelieferte Modell ist aufrufbar. Verfügbare ids und Preise liefert /v1/models.
Guthaben prüfenVerfügbare Credits jederzeit abfragen, damit ein Batch nicht mittendrin abbricht.

API-Design

Die Form folgt OpenAI: Schlüssel beginnen mit sk-, reisen in Authorization: Bearer, Pfade liegen unter /v1, und Fehler kommen als festes error-Objekt zurück. Wer das OpenAI-SDK kennt, tauscht im Wesentlichen nur die Basis-URL.

Bilder gehen beide Wege. Standard ist synchron: Der Aufruf wartet, bis das Bild fertig ist, und antwortet in derselben Form wie der OpenAI-Endpunkt images/generations – das OpenAI-SDK und Relay-Gateways können die Plattform also direkt als kompatiblen Anbieter einbinden. Mit async: true wird daraus der asynchrone Ablauf: Du bekommst sofort eine Auftrags-id und holst das Ergebnis per GET /v1/tasks/{id}.

Videos laufen ausschließlich asynchron: Das Rendern dauert Minuten, synchron zu warten hieße, direkt am Gateway-Timeout zu kleben, und ein Retry nach Timeout würde doppelt abrechnen. Bei Stapelverarbeitung, hoher Parallelität oder empfindlicher Latenz ist auch für Bilder der asynchrone Weg die bessere Wahl.

Basis-URL für alle Endpunkte: https://open.pikpikgo.com/v1

Nächste Schritte