PoYo CLIgói npm có sẵn

Khám phá và chạy các mô hình PoYo từ thiết bị của bạn.

Tìm kiếm danh mục mô hình trực tiếp và kiểm tra các kế hoạch mà không có khóa API. Truy hiệu khi bạn sẵn sàng để phát trực tuyến trò chuyện, gửi các công việc tạo hoặc tiếp tục một nhiệm vụ bằng task_id.

$npx -y @poyoapi/cli help

Xem trên npm GitHub Các tài liệu mở

Bắt đầu sử dụng PoYo CLI trong ba bước

Clan CLI, sau đó sử dụng mô hình và mô tả để chọn mô hình. Thêm khóa API chỉ khi bạn thực hiện mô hình hoặc đọc dữ liệu tài khoản.

Tiến hành CLI

Sử dụng npx mà không cần cài đặt toàn cầu. Các gói được công bố yêu cầu Node.js 20 hoặc mới hơn.

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

Chọn mô hình

Ví dụ này tìm mô hình gpt-image-2 hiện đang khả dụng, sau đó đọc Schema đầu vào mới nhất và giá công khai của mô hình. Cả hai lệnh đều không yêu cầu API Key.

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

Xác thực và thực thi

Tạo API Key rồi chạy ba lệnh bên dưới theo thứ tự. Kiểm tra giá bằng describe trước khi thực thi yêu cầu trả phí; tác vụ tạo thất bại không tiêu tốn tín dụng.

Tạo khóa API

1. Lưu API Key

Kết quả mong đợi: CLI yêu cầu nhập Key mà không hiển thị, sau đó báo keyring hoặc config là nơi lưu. Nếu kho thông tin xác thực của hệ thống không khả dụng, CLI dùng tệp cấu hình PoYo của người dùng hiện tại.

npx -y @poyoapi/cli auth login

2. Xác minh tài khoản và số dư

Kết quả mong đợi: thông tin tài khoản và số dư khả dụng. Mã 401 nghĩa là Key bị thiếu hoặc không hợp lệ.

npx -y @poyoapi/cli account

3. Xác nhận giá và thực thi

Đây là yêu cầu trả phí. Kết quả JSON thành công gồm task_id, trạng thái cuối và các tệp đầu ra.

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

Chuyển đổi Schema mô hình thành các lập luận CLI

Trước khi trò chuyện, chạy hoặc gửi, CLI đọc Schema của mô hình được chọn và chuyển đổi các trường của nó thành các lập luận cụ thể cho mô hình.

Tìm kiếm trước khi hành quyết

mô hình liệt kê danh sách công cộng. mô tả trả lại Schema chính xác, giao thức được hỗ trợ, chế độ thực thi, hỗ trợ callback và metadata hóa đơn cho một mô hình.

Hai lệnh này không yêu cầu một khóa API.

Tiếp tạo prompt

Một chuỗi Schema được chấp nhận như là giá trị dòng lệnh bình thường.

Các cờ mô hình không rõ ràng thất bại tại địa phương. Việc xác thực trường yêu cầu và hoàn chỉnh của chương trình JSON vẫn xảy ra trên API.

Trở lại ngay và phục hồi sau đó

submit trả về task_id ngay lập tức. task get đọc trạng thái hiện tại, trong khi task wait tiếp tục bỏ phiếu cho đến khi hoàn thành hoặc thời gian.

Sử dụng con đường này cho video, âm thanh, 3D và các công việc lâu dài khác.

Kiểm soát cách CLI trả về đầu ra

Streaming chat viết văn bản hoặc JSONL cho stdout. Các lệnh không phát trực tuyến có thể trả lại bảng, JSON, JSONL hoặc CSV đầu ra và viết nó vào tệp.

Các yêu cầu CLI sử dụng cùng các điểm cuối PoYo và hành vi thanh toán như các cuộc gọi REST API.

Chọn lệnh đúng cho mỗi nhiệm vụ

Các lệnh riêng biệt xử lý phát hiện mô hình, trò chuyện, tạo, phục hồi nhiệm vụ và cầu MCP địa phương.

~/projects/poyo-demo

# 1. Chọn mô hình
$ npx -y @poyoapi/cli models image --q gpt-image-2 --limit 1

# 2. Tạo lệnh nhập
$ npx -y @poyoapi/cli describe gpt-image-2
  prompt          string   required
  size            string   default: "1:1"
  output_format   string   enum: jpeg | png

# 3. Xác thực và thực thi
$ 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"]
}

Chuyển đời của nhiệm vụ

Cấp lại các nhiệm vụ lâu dài với task_id

PoYo trả lại trạng thái công tác hiện có trực tiếp. Nếu CLI thời gian ra hoặc ra, truy vấn cùng một nhiệm vụ thay vì gửi lại nó.

Một thời gian cất CLI không hủy bỏ công việc hậu thuẫn. Cứ trả cho một yêu cầu trùng lặp, tiếp tục với cùng task_id.

Sử dụng submit cho công việc dài

$ 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

Sử dụng chạy cho một thời gian chờ hạn

chạy cuộc thăm dò mỗi hai giây và chờ đến 90 giây trừ khi bạn chọn thời gian khác.

Sử dụng submit cho công việc dài

Giữ task_id trả về, sau đó sử dụng task get hoặc task wait từ một bước cuối hoặc CI khác.

Chọn giữa CLI, MCP, REST và Skill

Sử dụng CLI trong các thiết bị kết thúc và CI, MCP cho các cuộc gọi công cụ của Agent, REST API trong các ứng dụng và Skill cho các luồng công việc của Agent lặp lại.