リファレンス
本文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 | このキーの日別・モデル別の利用状況 | 課金 |
| ヘッダー | 向き | 意味 |
|---|
Idempotency-Key | リクエスト | 書き込みの再試行を 24 時間安全にする (冪等性) |
Accept-Language | リクエスト | エラー文の言語 (エラー) |
X-PopNow-Retention | リクエスト | タスク 1 件の内容を残す時間を短くする(秒) |
X-Request-Id | レスポンス | request_id と同じ。サポートに伝える |
X-RateLimit-Limit, X-RateLimit-Remaining, Retry-After | レスポンス | レート制限 (レート制限) |