PopNowAPI ドキュメント
リファレンス
本文

API リファレンス

PopNow API のすべてのエンドポイントを 1 ページで。OpenAPI 契約の全体へのリンク付き。

機械可読な完全版の契約は openapi.yaml(OpenAPI 3.1)です。Postman、Insomnia、コードジェネレーターに取り込んだり、AI エージェントに渡したりできます。このページは人が読むための地図です。

  • ベース URL:https://api.popnow.ai/api/v1(OpenAI 互換ルート:https://api.popnow.ai/v1)
  • **認証:**すべてのリクエストに Authorization: Bearer sk-popnow-…
  • 外枠:{ "code", "msg", "data", "request_id" }。code: 200 が成功
  • **金額:**整数のクレジット(credits、maxCredits …)と、同額の米ドル文字列。1 クレジット = $0.01

タスク

メソッドとパス内容ページ
POST /jobs/createTask生成タスクを作成(任意で ?wait=、最大 60 秒)タスク
GET /jobs/recordInfo?taskId=タスクの状態と結果を読むタスク
GET /jobsこのキーのタスク一覧タスク
POST /jobs/quote実行せずに料金を出す課金
POST /jobs/retry失敗・期限切れのタスクから新しいタスクを作るタスク
POST /jobs/purge終了したタスクの内容を削除タスク

モデル

メソッドとパス内容ページ
GET /models呼び出せる全モデルと料金(?includeSchema=1 で入力スキーマ付き)モデル
GET /models/{model}1 つのモデルと入力スキーマモデル

ファイルとアセット

メソッドとパス内容ページ
POST /common/upload-url直接アップロード用のチケットメディア
POST /files/{fileId}/commitアップロードを完了し popnow:// URI を得るメディア
POST /files/importリンクから LoRA ファイルを取り込むアセット
POST /common/download-urlタスク出力の新しい署名付きリンクメディア
GET /assets, POST /assetsアセットの一覧・保存アセット
GET, PATCH, DELETE /assets/{assetId}アセット 1 件の取得・名前変更・削除アセット
GET /assets/entitiesキャラクターアセット
GET /assets/usage保存プランと使用量アセット

アカウント

メソッドとパス内容ページ
GET /chat/credit残高:利用可能・確保中・合計課金
GET /usageこのキーの日別・モデル別の利用状況課金

OpenAI Videos 互換(/v1)

メソッドとパス内容ページ
POST /v1/videos動画タスクを作成OpenAI Videos
GET /v1/videos/{id}読むOpenAI Videos
GET /v1/videos/{id}/contentファイルへリダイレクトOpenAI Videos
GET /v1/modelsOpenAI 形式のモデル一覧OpenAI Videos

共通ヘッダー

ヘッダー向き意味
Idempotency-Keyリクエスト書き込みの再試行を 24 時間安全にする (冪等性)
Accept-Languageリクエストエラー文の言語 (エラー)
X-PopNow-Retentionリクエストタスク 1 件の内容を残す時間を短くする(秒)
X-Request-Idレスポンスrequest_id と同じ。サポートに伝える
X-RateLimit-Limit, X-RateLimit-Remaining, Retry-Afterレスポンスレート制限 (レート制限)

このページの内容