PixAI API ドキュメント
PixAI API の開発者向けドキュメント。REST API、API キー認証、非同期タスク、Webhook を使ってアニメ風 AI 画像をプログラムから生成できます。クイックスタートから始め、v2 / v1 のエンドポイントリファレンスへ進んでください。
PixAI API を使うと、pixai.art と同じモデル(Tsubaki.2、Haruka v2、Hoshino v2 など)でアニメ風の AI イラストをアプリケーションから生成できます。https://api.pixai.art で提供される REST API で、API キーで認証し、生成タスクを送信し、完了後に画像を取得する流れです。
API の流れ
- API キーを取得する。 PixAI API チームに申請するか、PixAI のプロフィールでキーを作成し、すべてのリクエストに
Authorization: Bearer <key>を付けます。詳しくは PixAI API を利用するには。 - タスクを作成する。 プロンプト、モデル、アスペクト比やスタイルなどの任意設定を
POST /v2/image/createに送ると、waiting状態のタスクが返ります。 - 完了を待つ。
GET /v1/task/{taskId}を 1.5 秒に 1 回以内の頻度でポーリングするか、Webhook を登録して完了時にタスクを受け取ります。 - 画像をダウンロードする。 完了したタスクにはメディア URL が含まれます。
GET /v1/media/{mediaId}はメディア情報を、GET /v1/media/{mediaId}/imageはファイルへのリダイレクトを返します。生成物は無期限には保存されないため、必要なファイルは保存してください。
ドキュメントを探す
クイックスタート
API アクセスの取得、最初のリクエスト、現在の制限。
画像生成(API v2)
アスペクト比・モード・スタイルプリセットを含む POST /v2/image/create のリファレンス。
タスクとメディア(API v1)
タスク状態の取得、メディアの取得とアップロード。
モデル
利用可能な画像モデルの ID・バージョン・サンプリング方法。
対応解像度
アスペクト比と解像度ティアごとの出力サイズ。
Webhook
ポーリングの代わりに POST でタスクの状態更新を受け取る。
制限
同時実行数、ポーリングの目安、API で未対応の機能。
よくあるご質問
メールとメンバーシップによるキー取得の違い、メンテナンス通知、API 生成物の公開範囲。
著作権とライセンス
生成画像の権利と PixAI モデルの商用利用条件。
機械可読版
- /llms.txt は本ドキュメントの全ページを一行要約付きで一覧し、/llms-full.txt は全ページを 1 つの Markdown にまとめたものです。
- 任意のページ URL の末尾に
.mdxを付けると Markdown として取得できます。例: /ja/docs/quick-start/limits.mdx
サポート
api@withpixai.art までメールいただくか、PixAI 公式 Discord の #api-beta-test チャンネルへどうぞ。詳細は フィードバック をご覧ください。