Sjekk miljøet og kjør CLI-en
Node.js 20 eller nyere kreves. Hvis node --version skriver ut v20 eller høyere, kan du kjøre CLI-en direkte via npx uten global installasjon.
node --version
npx -y @poyoapi/cli helpBla gjennom inndataskjemaer og offentlige priser for modellene som er tilgjengelige i den sanntidsoppdaterte katalogen hos PoYo – uten API-nøkkel. Legg bare til en nøkkel når du kjører en modell. Hvis en jobb tar lengre tid enn CLI-en venter, kan du fortsette å sjekke den med samme task_id.
$npx -y @poyoapi/cli helpIngen global installasjon kreves. Sjekk Node.js, undersøk modellen, autentiser deg og fullfør den første kjøringen.
Node.js 20 eller nyere kreves. Hvis node --version skriver ut v20 eller høyere, kan du kjøre CLI-en direkte via npx uten global installasjon.
node --version
npx -y @poyoapi/cli helpDette eksempelet finner den tilgjengelige modellen gpt-image-2 og leser deretter inndataskjemaet og den offentlige prisen i sanntid. Ingen av kommandoene krever API-nøkkel.
npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
npx -y @poyoapi/cli describe gpt-image-2Opprett en API-nøkkel, og fullfør deretter de tre kommandoene nedenfor i rekkefølge. Sjekk prisen med describe før den betalte kjøringen. Mislykkede genereringer bruker ikke kreditter.
Opprett API-nøkkel1. Lagre API-nøkkelen din
Forventet resultat: CLI-en ber om nøkkelen uten å vise den, og oppgir deretter keyring eller config som lagringssted. Hvis systemets legitimasjonslager ikke er tilgjengelig, brukes konfigurasjonsfilen for PoYo i stedet.
npx -y @poyoapi/cli auth login2. Bekreft kontoen og saldoen
Forventet resultat: kontoopplysninger og tilgjengelig saldo. 401 betyr at nøkkelen mangler eller er ugyldig.
npx -y @poyoapi/cli account3. Bekreft prisen og kjør
Dette er en betalt forespørsel. Et vellykket JSON-resultat inneholder task_id, endelig status og utdatafiler.
npx -y @poyoapi/cli run gpt-image-2 --prompt "cinematic product photo" --format jsonDen sanntidsoppdaterte katalogen forteller CLI-en hvilke modeller som finnes, hvilke inndata de tar imot, hvor lenge jobber spores og hvilket utdataformat skriptene får.
models viser den offentlige katalogen. describe returnerer det nøyaktige skjemaet, støttede protokoller, kjøremodus, støtte for callback og faktureringsmetadata for én modell.
Disse to kommandoene krever ikke API-nøkkel.
CLI-en leser det sanntidsoppdaterte skjemaet for hver modell og gjør feltene om til modellspesifikke kommandolinjevalg.
Ukjente modellflagg feiler lokalt. Validering av påkrevde felt og fullstendig validering mot JSON Schema skjer fortsatt i API-et.
submit returnerer en task_id med en gang. task get leser gjeldende tilstand, mens task wait fortsetter å spørre til oppgaven er ferdig eller tiden går ut.
Bruk helst submit for video, lyd, 3D og andre langvarige jobber.
Velg tabellutdata for mennesker, og bruk JSON, JSONL eller CSV for skript og CI. Kommandoer uten strømming kan også skrive resultatene til en fil.
Bruk --output FILE med kommandoer uten strømming. Strømmet tekst og JSONL går alltid til stdout.
Bla gjennom den offentlige katalogen, undersøk gjeldende inndata og pris for én modell, og be deretter om strukturerte utdata til skriptene dine.
# 1. Finn og undersøk en modell
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1
# 2. Undersøk skjemaet i sanntid
$ npx -y @poyoapi/cli describe gpt-image-2
prompt string required
size string default: "1:1"
output_format string enum: jpeg | png
# 3. Logg inn, verifiser og kjø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"]
}Livssyklus for oppgaver
Send inn video, lyd, 3D og annet langvarig arbeid én gang. Ta vare på task_id og fortsett ventingen fra en annen terminal eller et annet CI-trinn.
Et tidsavbrudd i CLI-en avbryter ikke jobben på serveren. Fortsett med samme task_id i stedet for å sende inn det samme arbeidet på nytt.
$ 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 sjekker oppgaven annethvert sekund og venter i opptil 90 sekunder som standard. Du kan angi et annet tidsavbrudd.
Kopier task_id-en som submit returnerer, og erstatt TASK_ID i wait-kommandoen. Du kan fortsette fra en annen terminal eller et annet CI-trinn.
Bruk CLI for mennesker og skallskript, MCP for verktøykall fra agenter, REST inne i applikasjoner og Skill for å gi en agent gjenbrukbare trinn og sikkerhetsregler for PoYo.
Utviklere, terminaler og CI
En person eller et skallskript skal finne modeller, kjøre dem, gjenoppta oppgaver og reagere på avslutningskoder fra prosessen.
Installer CLIAI-agenter og kodeklienter
En agent skal finne skjemaer, priser og kjøreverktøy via én tilkobling.
Se MCPApplikasjoner og tjenester
Applikasjonen din trenger direkte HTTP-kontroll over forespørsler, strømming, nye forsøk og callbacks.
Åpne dokumentasjonenGjentakbare agentflyter
En agent trenger gjenbrukbare arbeidstrinn og sikkerhetsregler i tillegg til tilgang via CLI, MCP eller REST.
Se SkillFortsatt usikker på en kommando? Kontakt kundestøtten hos PoYo→
CLI-en er MIT-lisensiert, publisert på npm og utviklet på GitHub. Bla først gjennom den offentlige katalogen, og opprett en API-nøkkel når du er klar til å kjøre en modell.