PoYo CLIпакет npm доступен

Находите и запускайте модели PoYo прямо из терминала.

Ищите модели и читайте Schema без API Key. Авторизуйтесь, когда понадобится потоковый чат, генерация или продолжение задачи по task_id.

$npx -y @poyoapi/cli help

Начните работу с PoYo CLI за три шага

Запустите CLI и выберите модель с помощью models и describe. API Key нужен только для запуска модели или чтения данных аккаунта.

1

Запустите CLI

Используйте npx без глобальной установки. Для пакета требуется Node.js 20 или новее.

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

Выберите модель

В этом примере выполняется поиск доступной модели gpt-image-2, а затем считываются её актуальная входная Schema и общедоступная цена. Ни для одной из двух команд не требуется API Key.

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

Авторизуйтесь и запустите

Создайте API Key и по порядку выполните три команды ниже. Перед платным запуском проверьте цену через describe; неудачная генерация не расходует кредиты.

Создать API Key

1. Сохранить API Key

Ожидаемый результат: CLI запрашивает Key, не отображая его, а затем сообщает keyring или config как место хранения. Если системное хранилище учётных данных недоступно, используется файл конфигурации PoYo текущего пользователя.

npx -y @poyoapi/cli auth login

2. Проверить аккаунт и баланс

Ожидаемый результат: данные аккаунта и доступный баланс. Код 401 означает, что Key отсутствует или недействителен.

npx -y @poyoapi/cli account

3. Подтвердить цену и запустить

Это платный запрос. Успешный JSON-результат содержит task_id, итоговый статус и выходные файлы.

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

Преобразуйте Schema модели в аргументы CLI

Перед chat, run или submit CLI читает Schema выбранной модели и преобразует поля в аргументы для этой модели.

Сначала найдите, потом запускайте

models показывает публичный каталог. describe возвращает Schema, протоколы, режим, Callback и биллинг.

Эти две команды не требуют API Key.

Промпт генерации

Строковое поле Schema передаётся как обычное значение командной строки.

Неизвестные параметры отклоняются локально. Полная проверка JSON Schema выполняется API.

Вернитесь сейчас, продолжите позже

submit сразу возвращает task_id. task get читает статус, task wait продолжает ожидание.

Подходит для долгих задач видео, аудио и 3D.

Управляйте форматом вывода CLI

Потоковый chat записывает текст или JSONL в stdout. Команды без потока могут вернуть table, JSON, JSONL или CSV и записать результат в файл.

CLI использует те же endpoints и правила биллинга, что REST API.

Выберите команду для каждой задачи

Отдельные команды отвечают за поиск моделей, чат, генерацию, продолжение задач и локальный MCP-мост.

~/projects/poyo-demo
# 1. Выберите модель
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1

# 2. Сформированный ввод команды
$ npx -y @poyoapi/cli describe gpt-image-2
  prompt          string   required
  size            string   default: "1:1"
  output_format   string   enum: jpeg | png

# 3. Авторизуйтесь и запустите
$ 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_id

PoYo напрямую возвращает существующий публичный статус задачи. Если CLI завершится или истечёт время ожидания, запросите ту же задачу вместо повторной отправки.

Timeout CLI не отменяет задачу backend. Используйте тот же task_id вместо повторной платной отправки.

submit для долгих задач
$ 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 для ограниченного ожидания

run проверяет каждые две секунды и по умолчанию ждёт не более 90 секунд.

submit для долгих задач

Сохраните task_id и используйте task get или task wait в другом терминале или шаге CI.

Вопросы о PoYo CLI

Остались вопросы по команде? Связаться с поддержкой PoYo

Запустите первую модель PoYo из терминала

Сначала изучите публичный каталог, а когда будете готовы запустить модель, создайте API Key.