API ドキュメント

概要

サイト内の画像生成・動画生成を、そのままあなたのプロダクトへ。

この API は、スタジオ画面で使われているものをそのまま公開しています。モデルも、料金体系も、レンダリング経路も同じです。ブラウザで作れるものはキーからも作れ、成果物は同じようにアセットライブラリへ入ります。

できること

テキスト / 画像 から画像参照画像、アスペクト比、1K/2K/4K の品質段階に対応。1 回あたり最大 4 枚。
テキスト / 画像 から動画開始・終了フレーム、参照画像、複数の解像度に対応。長さは選んだ仕様の範囲に収められます。
モデルを選べる提供中のモデルはすべて呼び出せます。利用可能な id と価格は /v1/models で取得。
クレジット確認残高をいつでも取得でき、バッチ処理が途中で止まる事態を防げます。

API の設計

形は OpenAI に沿っています。キーは sk- で始まり、Authorization: Bearer で送り、パスは /v1 配下、失敗時は決まった形の error オブジェクトが返ります。OpenAI SDK を使ったことがあれば、baseURL を差し替えるだけでほぼ動きます。

画像生成は同期と非同期の両方に対応します。既定は同期で、画像ができるまで待ってから応答し、レスポンスの形は OpenAI の images/generations と同じです。そのため OpenAI SDK や中継ゲートウェイから互換プロバイダーとしてそのまま利用できます。リクエストに async: true を入れると非同期になり、送信直後にタスク id が返るので GET /v1/tasks/{id} で結果を取得します。

動画生成は非同期のみです。レンダリングに数分かかるため、同期で待つと接続がゲートウェイのタイムアウト境界に張り付き、タイムアウト後の再試行で二重課金になります。バッチ処理や大量並列、レイテンシに敏感な用途では画像も非同期をおすすめします。

すべてのエンドポイントのベース URL:https://open.pikpikgo.com/v1

次のステップ