1
Tjek dit miljø, og kør CLI'en
Node.js 20 eller nyere er påkrævet. Hvis node --version viser v20 eller højere, kan du køre CLI'en direkte via npx uden en global installation.
node --version
npx -y @poyoapi/cli helpPoYo CLInpm-pakke tilgængelig
Alle PoYo-modeller — fra din terminal, dine scripts og dine agenter.
Gennemse inputskemaer og offentlige priser for de modeller, der lige nu findes i det aktuelle PoYo-katalog, uden en API-nøgle. Tilføj først en nøgle, når du kører en model. Hvis et job tager længere tid, end CLI'en venter, kan du blive ved med at følge det med det samme task_id.
$npx -y @poyoapi/cli helpTre trin fra opdagelse til resultat
Ingen global installation nødvendig. Tjek Node.js, undersøg modellen, log ind, og gennemfør din første kørsel.
2
Find og undersøg en model
Dette eksempel finder den aktuelt tilgængelige model gpt-image-2 og læser derefter dens aktuelle inputskema og offentlige pris. Ingen af kommandoerne kræver en API-nøgle.
npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
npx -y @poyoapi/cli describe gpt-image-23
Log ind, verificér og kør
Opret en API-nøgle, og kør derefter de tre kommandoer herunder i rækkefølge. Tjek prisen med describe før den betalte kørsel. Mislykkede genereringer bruger ingen kreditter.
Opret API-nøgle1. Gem din API-nøgle
Forventet: CLI'en beder om nøglen uden at vise den på skærmen og melder derefter keyring eller config som sted, hvor den er gemt. Hvis systemets legitimationslager ikke er tilgængeligt, falder den tilbage til din PoYo-konfigurationsfil.
npx -y @poyoapi/cli auth login2. Verificér kontoen og saldoen
Forventet: kontooplysninger og den tilgængelige saldo. En 401 betyder, at nøglen mangler eller er ugyldig.
npx -y @poyoapi/cli account3. Bekræft prisen, og kør
Dette er en betalt anmodning. Et vellykket JSON-resultat indeholder task_id, den endelige status og outputfilerne.
npx -y @poyoapi/cli run gpt-image-2 --prompt "cinematic product photo" --format jsonBygget til rigtige multimodale workflows
Det aktuelle katalog fortæller CLI'en, hvilke modeller der findes, hvilket input de accepterer, hvor længe job følges, og hvilket outputformat scripts modtager.
Søg, før du kører
models viser det offentlige katalog. describe returnerer det præcise skema, understøttede protokoller, kørselstilstand, understøttelse af callbacks og faktureringsmetadata for én model.
Disse to kommandoer kræver ikke en API-nøgle.
Skemaet bliver til kommandoflag
CLI'en læser hver models aktuelle skema og gør felterne til modelspecifikke kommandolinjeindstillinger.
Ukendte modelflag fejler lokalt. Kontrol af påkrævede felter og fuld validering af JSON-skemaet sker stadig i API'et.
Send én gang, fortsæt med task_id
submit returnerer et task_id med det samme. task get læser den aktuelle tilstand, mens task wait bliver ved med at aflæse, indtil opgaven er færdig, eller tiden løber ud.
Brug helst submit til video, lyd, 3D og andre langvarige job.
Struktureret output til scripts og CI
Vælg tabeloutput til mennesker, og brug JSON, JSONL eller CSV til scripts og CI. Kommandoer uden streaming kan også skrive resultater til en fil.
Brug --output FILE med kommandoer uden streaming. Streamet tekst og JSONL bliver på stdout.
Sådan ser en rigtig PoYo-session ud
Gennemse det offentlige katalog, undersøg en models aktuelle input og pris, og bed derefter om struktureret output til dine scripts.
~/projects/poyo-demo
# 1. Find og undersøg en model
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
# 2. Undersøg det aktuelle skema
$ npx -y @poyoapi/cli describe gpt-image-2
prompt string required
size string default: "1:1"
output_format string enum: jpeg | png
# 3. Log ind, verificér og kør
$ 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"]
}Opgavens livscyklus
Lange job behøver ikke at starte forfra
Send video, lyd, 3D og andet langvarigt arbejde én gang. Behold task_id'et, og fortsæt med at vente fra en anden terminal eller et andet CI-trin.
En timeout i CLI'en annullerer ikke jobbet i backenden. Fortsæt med det samme task_id i stedet for at sende det samme arbejde igen.
Brug submit, når terminalen ikke skal vente
$ 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
Brug run, når 90 sekunder er nok
run tjekker opgaven hvert andet sekund og venter som standard i op til 90 sekunder. Du kan angive en anden timeout.
Brug submit, når terminalen ikke skal vente
Kopiér det task_id, som submit returnerer, og erstat TASK_ID i wait-kommandoen. Du kan fortsætte fra en anden terminal eller et andet CI-trin.
Brug den rigtige grænseflade til den, der kalder
Brug CLI til mennesker og shell-scripts, MCP til værktøjskald fra agenter, REST inde i applikationer og Skill til at give en agent genbrugelige PoYo-trin og sikkerhedsregler.
PoYo CLI
Udviklere, terminaler og CI
Et menneske eller et shell-script skal finde modeller, køre dem, genoptage opgaver og reagere på processens exitkoder.
Installér CLIMCP
AI-agenter og kodeklienter
En agent skal finde skemaer, priser og værktøjer til kørsel via én forbindelse.
Se MCPREST-API
Applikationer og tjenester
Din applikation har brug for direkte HTTP-kontrol over anmodninger, streaming, genforsøg og callbacks.
Åbn dokumentationPoYo Skill
Gentagelige agentworkflows
En agent har brug for genbrugelige arbejdstrin og sikkerhedsregler ved siden af adgang via CLI, MCP eller REST.
Se SkillOfte stillede spørgsmål om PoYo CLI
Er du stadig i tvivl om en kommando? Kontakt PoYo-support→
PoYo CLI er en kommandolinjeklient til at finde og kalde PoYos modeller til chat, billede, video, lyd og 3D. Den læser de aktuelle modeldefinitioner fra det offentlige funktionskatalog, gør skemafelter til kommandoindstillinger og bruger de samme PoYo API-endpoints til kørsel og opgavestatus.
models og describe læser det offentlige funktionskatalog uden legitimationsoplysninger. Kommandoer til chat, generering, opgaver, konto og betalt kørsel kræver en API-nøgle.
run venter som standard i 90 sekunder. En timeout stopper den lokale aflæsning, men annullerer ikke opgaven i backenden. Fortsæt med npx -y @poyoapi/cli task wait TASK_ID.
Gem nøglen i CI'ens hemmelighedsstyring, og gør den tilgængelig som POYO_API_KEY. Fastlås @poyoapi/cli@VERSION for reproducerbare kørsler, bed om --format json, og behandl enhver exitkode forskellig fra nul som en fejl. Læg aldrig legitimationsoplysninger i kommandohistorikken eller i filer i repositoriet.
Nej. CLI'en kalder de samme endpoints. describe viser den valgte models offentlige pris, og account viser din aktuelle saldo. run og submit er betalte. Der trækkes kun kreditter, når en generering lykkes. En 401 betyder, at nøglen mangler eller er ugyldig, mens 402 betyder, at kontoen har for få kreditter.
Den kører en stdio-bro, der videresender JSON-RPC-beskeder til https://api.poyo.ai/mcp. Kørslen af modellen sker fortsat på PoYos fjerntjeneste.
Open source. Klar fra enhver terminal.
CLI'en er udgivet under MIT-licens på npm og udvikles på GitHub. Gennemse først det offentlige katalog, og opret en API-nøgle, når du er klar til at køre en model.