PopNowAPI ドキュメント
はじめに
本文

SDK、CLI、オープンソースツール

Python、JavaScript、Go、PHP、Java の公式オープンソース PopNow SDK、CLI、MCP の設定ガイド、Agent Skills、サーバー側プロキシ、チャットボット、Blender・ComfyUI・n8n との連携。インストールは PyPI、npm、Packagist、Maven Central、Comfy Registry から。

PopNow が開発者向けに公開しているものはすべて、MIT ライセンスのオープンソースで、GitHub の popnow-ai 組織にあります。SDK は、このドキュメントで説明している同じ REST API をラップしています。そのため、ここにあるページはすべて引き続き当てはまります。モデル ID、input のフィールド、API の USD 残高は同じです。

パッケージは PyPI、npm、Packagist、Maven Central、Comfy Registry に公開されています。このページのコマンドでインストールしてください。素の HTTP もそのまま使えます。このドキュメントのすべての例は curl、fetch、requests を使っています。

一覧

リポジトリ内容インストール
popnow-pythonPython SDK。同期と非同期pip install popnow
popnow-jsNode.js 18 以降、Deno、Bun、エッジランタイム向けの JavaScript・TypeScript SDKnpm install popnow
popnow-clipopnow コマンドラインツールnpm install -g @popnow/cli
popnow-goGo クライアントgo get github.com/popnow-ai/popnow-go
popnow-phpPHP クライアントcomposer require popnow/popnow
popnow-javaJava 17 以降、Kotlin、その他の JVM 言語向けのクライアントMaven Central の ai.popnow:popnow-java
popnow-mcpリモート MCP サーバーの設定ガイドとクライアント別の設定インストール不要
popnow-skillsClaude Code、Codex、その他のエージェント向けの Agent SkillsClaude Code のプラグインマーケットプレース
popnow-apiOpenAPI ファイル、curl・Python・Node の例、n8n ワークフロークローンまたはコピー
popnow-proxyブラウザやモバイルアプリがキーを持たずに API を呼べるようにするサーバー側プロキシnpm install @popnow/proxy
popnow-bot画像、動画、動画エフェクトを扱う、自分で動かす Telegram・Discord ボットDocker
popnow-blenderBlender アドオンのソースpopnow.ai/blender の zip
popnow-comfyuiComfyUI のカスタムノードパックComfyUI Manager、または comfy node install popnow-comfyui
n8n-nodes-popnown8n のコミュニティノード(セルフホストの n8n)Settings > Community Nodes: n8n-nodes-popnow

すべてのツールには、API コンソールで作成した API キーが必要です。POPNOW_API_KEY に設定してください。SDK と CLI はそこから読み取ります:

export POPNOW_API_KEY="sk-popnow-..."

Python SDK

popnow-python には、同期クライアント(PopNow)と非同期クライアント(AsyncPopNow)があります。型付きの結果、Idempotency-Key ヘッダーの自動付与、429 と 503 での再試行、ファイルのアップロード、アセットライブラリ、Webhook の署名検証に対応しています。Python 3.9 以降が必要で、依存関係は httpx だけです。

pip install popnow
Python (popnow SDK)
from popnow import PopNow

client = PopNow()  # reads POPNOW_API_KEY

task = client.images.generate(
    model="alibaba/z-image-turbo/text-to-image",
    prompt="A small red fox curled up in a teacup, soft morning light",
)
print(task.state, task.cost, "USD", task.urls[0])

images.generate はタスクを作成し、完了を待ち、成功しなければ TaskFailedError を送出します。より低レベルの client.jobs.quote()、create()、get()、wait() は、タスクのエンドポイントと一対一に対応しています。

JavaScript と TypeScript の SDK

popnow-js は実行時の依存関係がなく、標準の fetch を使うため、Node.js 18 以降、Deno、Bun、Cloudflare Workers などのエッジランタイムで動きます。型定義付きの ESM と CommonJS のビルドを提供しています。

npm install popnow

Deno と Bun では JSR にもあります。deno add jsr:@popnow/popnow または npx jsr add @popnow/popnow を使ってください。

JavaScript (popnow SDK)
import { PopNow } from 'popnow';

const popnow = new PopNow(); // reads POPNOW_API_KEY

const task = await popnow.jobs.createAndWait({
  model: 'alibaba/z-image-turbo/text-to-image',
  input: { prompt: 'A small red fox curled up in a teacup, soft morning light' },
});
console.log(task.state, task.output?.assets?.[0]?.url);

createAndWait は Idempotency-Key を自動で送り、タスクが最終状態になるまでポーリングします。事前に料金を確認したい場合や、別の場所で待ちたい場合は、jobs.quote、jobs.create、jobs.wait を使ってください。

コマンドライン

popnow-cli は、スクリプト、CI ジョブ、ターミナルからの簡単なテストのための popnow コマンドをインストールします。Node.js 22.12 以降が必要です。

npm install -g @popnow/cli
popnow --help

インストールせずに一度だけ実行するには: npx @popnow/cli status。

Go と PHP

popnow-go は通常の Go モジュールです(Go 1.23 以降)。

go get github.com/popnow-ai/popnow-go

popnow-php(PHP 8.1 以降)は Packagist の popnow/popnow です。

composer require popnow/popnow

Java

popnow-java は Java 17 以降、Kotlin、その他の JVM 言語向けのクライアントで、Maven Central に ai.popnow:popnow-java として公開されています。唯一の依存関係は Jackson databind で、HTTP は JDK 標準の HttpClient を通ります。

pom.xml
<dependency>
  <groupId>ai.popnow</groupId>
  <artifactId>popnow-java</artifactId>
  <version>0.1.0</version>
</dependency>
build.gradle.kts
dependencies {
    implementation("ai.popnow:popnow-java:0.1.0")
}
Java (popnow-java)
import ai.popnow.*;
import java.util.Map;
import java.util.UUID;

PopNowClient client = PopNowClient.builder().apiKeyFromEnvironment().build(); // POPNOW_API_KEY

CreateTaskRequest request = CreateTaskRequest.of("alibaba/z-image-turbo/text-to-image",
        Map.of("prompt", "A small red fox curled up in a teacup, soft morning light"));

TaskRecord task = client.run(request, UUID.randomUUID().toString()); // createTask + waitForTerminal
System.out.println(task.state() + " for " + task.cost() + " USD");

run は渡された Idempotency-Key でタスクを作成し、最終状態になるまで待ちます。2 つの手順を分けたい場合は、createTask と waitForTerminal を使ってください。

MCP と Agent Skills

リモート MCP サーバーにはパッケージは要りません。ChatGPT、Claude、Cursor、VS Code、Claude Code に https://api.popnow.ai/mcp を追加するだけです。popnow-mcp には、各クライアント向けのコピー&ペーストできる設定と、ローカルサーバーしか起動できないクライアント向けの小さな stdio ブリッジが入っています。ブリッジは npm に @popnow/mcp として公開されているので、npx -y @popnow/mcp でインストールの手順なしに実行できます。

popnow-skills は、コーディングエージェントに REST API で動画、画像、音楽、ナレーションを作らせ、API リファレンスを調べさせるためのものです。Claude Code では次のとおりです。

/plugin marketplace add popnow-ai/popnow-skills
/plugin install popnow@popnow-skills

README には Codex、Claude のアプリ、その他のエージェントの説明もあります。

例と連携

  • popnow-api には OpenAPI ファイル、そのまま実行できる curl・Python・Node.js の例、インポートできる n8n ワークフローがあります。ほかの言語のクライアントが必要なら、OpenAPI ファイルをコード生成ツールに渡してください。
  • popnow-blender は Blender アドオンのソースです。インストールするには popnow.ai/blender から zip をダウンロードしてください。このリポジトリからも同じ zip をビルドできます。
  • popnow-comfyui は Comfy Registry にある ComfyUI のノードパックです。モデルごとのノードに加え、PopNow Generate と PopNow LoRA があります。ComfyUI Manager で Custom Nodes Manager を開き、PopNow を検索して Install をクリックするか、comfy node install popnow-comfyui を実行してください。手順の全体と、1 分で読み終えられる 1 ファイルのノードは ComfyUI にあります。
  • n8n-nodes-popnow は、セルフホストの n8n 向けの n8n コミュニティノードで、npm にあります。Settings > Community Nodes > Install を開いて n8n-nodes-popnow と入力するか、シェルから入れて n8n を再起動してください。まだ検証済みのノードではないため、n8n Cloud からは入れられません。HTTP Request のワークフローはインストールが要らず、n8n Cloud でも動きます。
  • popnow-proxy は、Next.js、Express、その他の fetch ランタイム向けの小さなサーバー側ルートです。ブラウザ、モバイル、デスクトップのアプリがお使いのサーバーを呼び出し、プロキシがそこで API キーを付けるので、キーがクライアントに配布されることはありません。Node.js 22.12 以降が必要です。
  • popnow-bot は、Docker で自分で動かす Telegram と Discord のボットです。チャットで画像、動画、動画エフェクトを扱え、有料の実行の前に料金を確認でき、1 日の利用上限も設定できます。リポジトリをクローンして docker compose up -d --build で起動するか、ビルド済みの popnow/popnow-bot イメージを Docker Hub から取得してください。
# n8n community node, from a shell on self-hosted n8n
mkdir -p ~/.n8n/nodes && cd ~/.n8n/nodes
npm install n8n-nodes-popnow
# server-side proxy
npm install @popnow/proxy

公式の PopNow SDK はありますか?

はい。このページにある Python と JavaScript の SDK、CLI、Go・PHP・Java のクライアントは、PopNow が保守しており、github.com/popnow-ai の下でオープンソースとして公開しています。

SDK は npm や PyPI にありますか?

はい。pip install popnow は PyPI から Python SDK を、npm install popnow は npm から JavaScript SDK をインストールします。CLI は npm の @popnow/cli、PHP クライアントは Packagist の popnow/popnow、Java クライアントは Maven Central の ai.popnow:popnow-java、ComfyUI のパックは Comfy Registry の popnow-comfyui です。各リポジトリの CHANGELOG.md に、そのリリースが一覧されています。

SDK と REST API のどちらを使うべきですか?

どちらでも構いません。SDK は再試行、冪等キー、ポーリング、型付きの結果を追加してくれます。素の HTTP は何もインストールする必要がなく、このドキュメントのすべての例が示しているのはこちらです。

SDK に料金はかかりますか?

かかりません。コードは MIT ライセンスで無料です。API の生成はウェブサイトと同じモデルの料金基準で、独立した API USD 残高を使います。API billing で入金してください。OAuth MCP はウェブサイトのクレジット、API キーの MCP は API USD を使います。

バグはどこに報告すればよいですか?

そのバグのリポジトリで issue を開いてください。セキュリティの問題は、公開の issue を開かず、そのリポジトリの SECURITY.md の手順に従ってください。

このページの内容