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 helpParcourez 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 helpExé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.
Utilisez npx sans installation globale. Le package publié nécessite Node.js 20 ou une version ultérieure.
node --version
npx -y @poyoapi/cli helpCet 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-2Cré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 Key1. 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 login2. 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 account3. 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 jsonAvant chat, run ou submit, la CLI lit le Schema du modèle choisi et convertit ses champs en arguments propres au modèle.
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.
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.
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.
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.
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.
# 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
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.
$ 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 interroge l’état toutes les deux secondes et attend 90 secondes par défaut.
Conservez le task_id, puis utilisez task get ou task wait dans un autre terminal ou une étape CI.
Utilisez CLI dans le terminal et en CI, MCP pour les appels d’outils de l’Agent, REST API dans les applications et Skill pour les workflows d’Agent répétables.
Développeurs, terminaux et CI
Une personne ou un script doit découvrir, exécuter, reprendre et lire les codes de sortie.
Installer CLIAgents IA et clients de code
Un Agent doit découvrir Schema, prix et outils via une connexion.
Voir MCPApplications et services
Votre produit contrôle l’orchestration, le streaming, les nouvelles tentatives et le trafic.
Ouvrir la docWorkflows Agent reproductibles
Un Agent a besoin d’instructions et de règles de sécurité en plus des interfaces.
Voir SkillEncore un doute sur une commande ? Contacter le support PoYo→
Explorez d’abord le catalogue public, puis créez une API Key quand vous êtes prêt à exécuter un modèle.