CLI starten
Nutze npx ohne globale Installation. Das veröffentlichte Paket benötigt Node.js 20 oder neuer.
node --version
npx -y @poyoapi/cli helpDurchsuche den aktuellen Modellkatalog und lies Schemas ohne API Key. Authentifiziere dich erst, wenn du Chats streamst, Generierungsjobs startest oder einen Task per task_id fortsetzt.
$npx -y @poyoapi/cli helpFühre zuerst die CLI aus und wähle dann mit models und describe ein Modell. Einen API Key brauchst du erst für die Modellausführung oder Kontodaten.
Nutze npx ohne globale Installation. Das veröffentlichte Paket benötigt Node.js 20 oder neuer.
node --version
npx -y @poyoapi/cli helpDieses Beispiel findet das aktuell verfügbare Modell gpt-image-2 und liest anschließend dessen aktuelles Eingabe-Schema und öffentlichen Preis aus. Für keinen der beiden Befehle ist ein API-Schlüssel erforderlich.
npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
npx -y @poyoapi/cli describe gpt-image-2Erstelle einen API Key und führe dann die drei Befehle unten der Reihe nach aus. Prüfe vor dem kostenpflichtigen Lauf den Preis mit describe; fehlgeschlagene Generierungen verbrauchen keine Credits.
API Key erstellen1. API Key speichern
Erwartet: Die CLI fragt nach dem Key, ohne ihn anzuzeigen, und meldet danach keyring oder config als Speicherort. Ist der System-Schlüsselspeicher nicht verfügbar, nutzt sie deine PoYo-Konfigurationsdatei.
npx -y @poyoapi/cli auth login2. Konto und Guthaben prüfen
Erwartet: Kontodaten und verfügbares Guthaben. 401 bedeutet, dass der Key fehlt oder ungültig ist.
npx -y @poyoapi/cli account3. Preis bestätigen und ausführen
Dies ist eine kostenpflichtige Anfrage. Ein erfolgreiches JSON-Ergebnis enthält task_id, Endstatus und Ausgabedateien.
npx -y @poyoapi/cli run gpt-image-2 --prompt "cinematic product photo" --format jsonVor chat, run oder submit liest die CLI das Schema des gewählten Modells und wandelt seine Felder in modellspezifische Parameter um.
models listet den öffentlichen Katalog. describe liefert Schema, Protokolle, Ausführungsmodus, Callback- und Abrechnungsdaten.
Beide Befehle funktionieren ohne API Key.
Ein Schema-String wird als normaler Kommandozeilenwert übergeben.
Unbekannte Modelloptionen scheitern lokal. Die vollständige JSON-Schema-Prüfung erfolgt weiterhin in der API.
submit gibt sofort eine task_id zurück. task get liest den Status, task wait wartet weiter.
Geeignet für lange Video-, Audio- und 3D-Jobs.
Streaming-Chat schreibt Text oder JSONL nach stdout. Nicht streamende Befehle liefern table, JSON, JSONL oder CSV und können die Ausgabe in eine Datei schreiben.
CLI-Anfragen verwenden dieselben Endpoints und dieselbe Abrechnung wie REST API.
Eigene Befehle übernehmen Modellsuche, Chat, Generierung, Task-Wiederaufnahme und die lokale MCP-Bridge.
# 1. Modell auswählen
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
# 2. Erzeugte Befehlseingabe
$ npx -y @poyoapi/cli describe gpt-image-2
prompt string required
size string default: "1:1"
output_format string enum: jpeg | png
# 3. Authentifizieren und ausführen
$ npx -y @poyoapi/cli run gpt-image-2 --prompt "cinematic product photo" --size 4:3 --output-format png --format json
{
"task_id": "task_7f31b2",
"status": "succeeded",
"files": ["https://storage.poyo.ai/.../image.png"]
}Task-Lebenszyklus
PoYo gibt den bestehenden öffentlichen Task-Status direkt zurück. Wenn die CLI abbricht oder das Zeitlimit erreicht, fragst du denselben Task weiter ab, statt ihn erneut zu senden.
Ein CLI-Timeout storniert den Backend-Task nicht. Nutze dieselbe task_id statt eine kostenpflichtige Anfrage zu wiederholen.
$ npx -y @poyoapi/cli submit gpt-image-2 --prompt "cinematic product photo" --format jsontask_id task_7f31b2
$ npx -y @poyoapi/cli task wait TASK_ID --timeout 300 --format jsonstatus succeeded
run fragt alle zwei Sekunden ab und wartet standardmäßig höchstens 90 Sekunden.
Speichere die task_id und nutze task get oder task wait in einem anderen Terminal oder CI-Schritt.
Nutze die CLI im Terminal und in CI, MCP für Agent-Toolaufrufe, die REST API in Anwendungen und Skill für wiederholbare Agent-Workflows.
Entwickler, Terminal und CI
Menschen oder Skripte brauchen Suche, Ausführung, Wiederaufnahme und Exit-Codes.
CLI installierenAI Agents und Coding-Clients
Ein Agent soll Schema, Preise und Tools über eine Verbindung entdecken.
MCP ansehenAnwendungen und Services
Das Produkt steuert Orchestrierung, Streaming, Wiederholungen und Traffic selbst.
Docs öffnenWiederholbare Agent-Workflows
Ein Agent benötigt zusätzlich zu Schnittstellen Arbeitsanweisungen und Sicherheitsregeln.
Skill ansehenNoch unsicher bei einem Befehl? PoYo-Support kontaktieren→
Erkunde zuerst den öffentlichen Katalog und erstelle einen API Key, wenn du ein Modell ausführen möchtest.