Übersicht/OpenAPI/Übersicht

Übersicht

Erfahren Sie, wie Sie die Erstellung von KPainter in Ihr Produkt integrieren.

Bringen Sie KPainter in Ihr Produkt

KPainter OpenAPI ist für Entwickler, die Inhalte innerhalb ihres eigenen Produkts, Automatisierung oder Agent-Workflow erstellen möchten. Es gibt drei öffentliche Produkte:

Produkt Typ Am besten für
Erklärvideo Video Kurse, Ausbildung, SOPs, Forschungsergebnisse, Produktbildung und Wissenserklärer
KI-Bild Bild Poster, Abdeckungen, Illustrationen und Single-Image-Konzepte
KI-App App Interaktive Seiten, Simulationen, Quests und kleine Tools

PDFs, Präsentationen, Dokumente und Bilder sind Quellmaterial; sie wählen nicht das Ausgangsprodukt aus. Explainer Video kann auch eine Webseiten-URL als Quellkontext verwenden.

Basis URL

Alle Produktionsanforderungen beginnen hier:

https://api.kpainter.ai/openapi/v1

Zum Beispiel sind die vollständigen Kapazitäten endpoint:

https://api.kpainter.ai/openapi/v1/capabilities

Ein komplettes Kreativfluss

  1. Anrufen Sie GET /me, um den API-Schlüssel zu überprüfen.
  2. Anrufen Sie GET /Kapazitäten, um aktuelle Optionen zu entdecken.
  3. Hinzufügen von Anlagen mit POST / Dateien.
  4. Erstellen Sie ein Video, ein Bild oder eine App mit POST/Creations.
  5. Poll GET /creations/{id} für Status und Fortschritt.
  6. Lesen Sie GET /creations/{id}/outputs, wenn die Lieferung verfügbar ist.
  7. Verwenden Sie Nachrichten, um ein Explainer Video zu verfeinern. Wenn eine Aufgabe aufhört, führen Sie nur eine in verfügbaren_Aktionen aufgeführte Aktion durch.

Hauptendpunkte

Endpunkt Zweck
GET / Gesundheit Überprüfen Sie die Verfügbarkeit von Dienstleistungen
GET / ME Überprüfen Sie den aktuellen Konto
Fähigkeiten / Capacities Entdecken Sie Produkte, Parameter, Template und Modelle
Nachrichten / Files Einträge Dateien hochladen
Post / Kreationen Inhalt erstellen
GET / Kreationen Liste der Konto-Kreationen
GET / Kreationen /{id} Lesen Sie Status, Fortschritt, ETA, Credits und Bewertung
POST / Kreationen / {id} / Nachrichten Erstellen Sie ein Video mit Erläuterung
POST / Kreationen / {id} / Aktionen Folgen Sie der neuesten Pause-Task
GET / Kreationen /{id} / Ausgänge Lesen Sie QA- genehmigte Ausgaben

Was in Denken zu halten

  • Authentikierung mit einem Bearer API-Schlüssel.
  • Die öffentlichen Forderungs- und Antragsfelder verwenden Snake_case.
  • Senden Sie nur Parameterwerte zurück, die durch Kapazitäten zurückgegeben werden.
  • Ein gewöhnliches Versagen berichtet nicht über tatsächliche Kredite.
  • ETA wird vergessen, wenn es nicht zuverlässig geschätzt werden kann.
  • Lesen Sie benutzerdefinierte Ergebnisse aus den Endpunkten nach Abschluss, anstatt Speicher-URLs zu konstruieren.