PoYo CLIpackage npm disponible

Découvrez et exécutez les modèles PoYo depuis votre terminal.

Parcourez le catalogue en temps réel et consultez les Schema sans API Key. Authentifiez-vous ensuite pour diffuser un chat, soumettre une génération ou reprendre une tâche avec son task_id.

$npx -y @poyoapi/cli help

Prendre en main PoYo CLI en trois étapes

Exécutez la CLI, puis choisissez un modèle avec models et describe. Ajoutez une API Key uniquement pour exécuter un modèle ou consulter votre compte.

1

Lancer la CLI

Utilisez npx sans installation globale. Le package publié nécessite Node.js 20 ou une version ultérieure.

node --version
npx -y @poyoapi/cli help
2

Choisir un modèle

Cet exemple recherche le modèle gpt-image-2 actuellement disponible, puis consulte son Schema d’entrée en temps réel et son tarif public. Aucune des deux commandes ne nécessite de clé API.

npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
npx -y @poyoapi/cli describe gpt-image-2
3

S’authentifier et exécuter

Créez une API Key, puis exécutez dans l’ordre les trois commandes ci-dessous. Vérifiez le prix avec describe avant l’exécution payante ; une génération échouée ne consomme pas de crédits.

Créer une API Key

1. Enregistrer l’API Key

Résultat attendu : la CLI demande la Key sans l’afficher, puis indique keyring ou config comme emplacement. Si le gestionnaire d’identifiants système est indisponible, elle utilise votre fichier de configuration PoYo.

npx -y @poyoapi/cli auth login

2. Vérifier le compte et le solde

Résultat attendu : les informations du compte et le solde disponible. Une erreur 401 signifie que la Key est absente ou invalide.

npx -y @poyoapi/cli account

3. Confirmer le prix et exécuter

Il s’agit d’une requête payante. Un résultat JSON réussi contient task_id, l’état final et les fichiers de sortie.

npx -y @poyoapi/cli run gpt-image-2 --prompt "cinematic product photo" --format json

Convertir le Schema d’un modèle en arguments CLI

Avant chat, run ou submit, la CLI lit le Schema du modèle choisi et convertit ses champs en arguments propres au modèle.

Rechercher avant d’exécuter

models liste le catalogue public. describe retourne le Schema, les protocoles, le mode d’exécution, les callbacks et la facturation.

Ces deux commandes ne nécessitent pas d’API Key.

Prompt de génération

Un champ texte du Schema devient une valeur de ligne de commande.

Une option inconnue échoue localement. La validation complète du JSON Schema reste effectuée par l’API.

Revenir maintenant, reprendre plus tard

submit renvoie immédiatement un task_id. task get lit l’état, task wait poursuit l’attente.

Cette voie convient aux tâches longues de vidéo, audio et 3D.

Contrôler le format de sortie de la CLI

Le chat en streaming écrit du texte ou du JSONL dans stdout. Les commandes non streamées peuvent renvoyer table, JSON, JSONL ou CSV et écrire le résultat dans un fichier.

La CLI utilise les mêmes endpoints et la même facturation que REST API.

Choisir la bonne commande pour chaque tâche

Des commandes distinctes gèrent la recherche de modèles, le chat, la génération, la reprise de tâche et la passerelle MCP locale.

~/projects/poyo-demo
# 1. Choisir un modèle
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1

# 2. Entrée de commande générée
$ npx -y @poyoapi/cli describe gpt-image-2
  prompt          string   required
  size            string   default: "1:1"
  output_format   string   enum: jpeg | png

# 3. S’authentifier et exécuter
$ 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"]
}

Cycle de tâche

Reprendre une tâche longue avec task_id

PoYo renvoie directement l’état public existant de la tâche. Si la CLI expire ou s’arrête, interrogez la même tâche au lieu de la soumettre à nouveau.

Un timeout CLI n’annule pas la tâche backend. Réutilisez le même task_id au lieu de payer une requête en double.

submit pour les tâches longues
$ npx -y @poyoapi/cli submit gpt-image-2 --prompt "cinematic product photo" --format json

task_id task_7f31b2

$ npx -y @poyoapi/cli task wait TASK_ID --timeout 300 --format json

status succeeded

run pour une attente limitée

run interroge l’état toutes les deux secondes et attend 90 secondes par défaut.

submit pour les tâches longues

Conservez le task_id, puis utilisez task get ou task wait dans un autre terminal ou une étape CI.

FAQ PoYo CLI

Encore un doute sur une commande ? Contacter le support PoYo

Exécutez votre premier modèle PoYo dans le terminal

Explorez d’abord le catalogue public, puis créez une API Key quand vous êtes prêt à exécuter un modèle.