PixAI Platform

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 の流れ

  1. API キーを取得する。 PixAI API チームに申請するか、PixAI のプロフィールでキーを作成し、すべてのリクエストに Authorization: Bearer <key> を付けます。詳しくは PixAI API を利用するには
  2. タスクを作成する。 プロンプト、モデル、アスペクト比やスタイルなどの任意設定を POST /v2/image/create に送ると、waiting 状態のタスクが返ります。
  3. 完了を待つ。 GET /v1/task/{taskId} を 1.5 秒に 1 回以内の頻度でポーリングするか、Webhook を登録して完了時にタスクを受け取ります。
  4. 画像をダウンロードする。 完了したタスクにはメディア URL が含まれます。GET /v1/media/{mediaId} はメディア情報を、GET /v1/media/{mediaId}/image はファイルへのリダイレクトを返します。生成物は無期限には保存されないため、必要なファイルは保存してください。

ドキュメントを探す

機械可読版

  • /llms.txt は本ドキュメントの全ページを一行要約付きで一覧し、/llms-full.txt は全ページを 1 つの Markdown にまとめたものです。
  • 任意のページ URL の末尾に .mdx を付けると Markdown として取得できます。例: /ja/docs/quick-start/limits.mdx

サポート

api@withpixai.art までメールいただくか、PixAI 公式 Discord#api-beta-test チャンネルへどうぞ。詳細は フィードバック をご覧ください。

On this page