# PixAI Platform > Developer documentation for the PixAI API, a REST API that generates anime-style AI images and videos with the same models that power pixai.art. It covers getting API access, authenticating with an API key, submitting asynchronous generation tasks, webhooks, and the v2 and v1 endpoint references. ## When to use PixAI Use the PixAI API when a user wants anime, manga, game-art or other stylized illustration generated or edited, in particular: - Generate an anime-style image from a text prompt, optionally with LoRAs, a style preset or a color palette (`POST /v2/image/create`). - Generate from 1-3 reference images, for example to keep a character consistent across images or take a pose from another picture (`contextImages` on `POST /v2/image/create`). - Redraw part of an image, or extend it past its edges (`POST /v2/gen-task/inpaint`). - Animate a still image, or make a short video from reference images and audio (`POST /v2/frame-video/create`, `POST /v2/reference-video/create`). - Find a model or LoRA, with its trigger words and supported sizes, before generating (`GET /v2/generation-model/search`). Do not use it for photorealistic photos, or for text, code or speech generation. How to call it: send an API key as `Authorization: Bearer ` to `https://api.pixai.art`. Every generation is an asynchronous task: the create call returns a task ID, then poll `GET /v2/task/{id}` no more than once every 1.5 seconds (or register a webhook) until it completes, and resolve the output media IDs to URLs with `GET /v2/media/batch?ids=`. Upload your own input images first with `POST /v2/media/image/upload-url`. Each generation spends credits from the key owner's account. Coding agents can also search and read these docs through a docs-only MCP server at `https://platform.pixai.art/docs-mcp` (Streamable HTTP, no authentication); setup: [Docs MCP server](https://platform.pixai.art/ja/docs/docs-mcp). The sections below list the Japanese pages. The docs are also available in other languages; their indexes are listed under Optional. ## ドキュメント - [PixAI API ドキュメント](https://platform.pixai.art/ja/docs): PixAI API の開発者向けドキュメント。REST API、API キー認証、非同期タスク、Webhook を使ってアニメ風 AI 画像をプログラムから生成できます。クイックスタートから始め、v2 / v1 のエンドポイントリファレンスへ進んでください。 - [ドキュメント MCP サーバー](https://platform.pixai.art/ja/docs/docs-mcp): Claude Code、Cursor、VS Code などの MCP クライアントをドキュメント MCP サーバー (https://platform.pixai.art/docs-mcp) に接続すると、AI エージェントがこのドキュメントを検索・参照できます。画像の生成は行いません。 - [よくあるご質問(FAQ)](https://platform.pixai.art/ja/docs/faq): PixAI API のよくあるご質問。メール申請とメンバーシップで取得する API キーの違い、メンテナンス通知の受け取り方、API で生成した画像の履歴、問い合わせの対応言語をまとめています。 ## クイックスタート PixAI API の始め方。アカウント登録から最初のリクエストまでを解説します。 - [PixAI APIを使用するには?](https://platform.pixai.art/ja/docs/quick-start/enroll-in-api): PixAI API の利用申請方法と API キーの取得方法について説明します。 - [最初のAPIリクエスト](https://platform.pixai.art/ja/docs/quick-start/first-api-call): タスクの送信、ステータスの確認、画像のダウンロードまで、PixAI API への最初のリクエストをステップごとに説明します。 - [制限事項](https://platform.pixai.art/ja/docs/quick-start/limits): PixAI API の利用制限について説明します。待機中のタスク数の上限、ポーリング間隔の目安、現在対応していない機能を確認できます。 - [このドキュメントについて](https://platform.pixai.art/ja/docs/quick-start): PixAI API ドキュメントの概要と、PixAI プラットフォームを使い始める方法を説明します。 ## API v2 ドキュメント 現在の API。画像・動画の生成、画像編集、アップロード、モデル・LoRA・カラーパレットの検索を扱います。 ### 画像 画像を生成・編集します。 - [画像生成タスクの作成](https://platform.pixai.art/ja/docs/api-v2/image/createImage): 簡略化された v2 API で非同期の画像生成タスクを開始します。レスポンスには作成されたタスクの ID が含まれます。 - [インペイント・アウトペイント・リドロータスクの作成](https://platform.pixai.art/ja/docs/api-v2/image/createInpaint): 既存の画像を編集します: - [インペイントプリセットの制限の取得](https://platform.pixai.art/ja/docs/api-v2/image/getInpaintConstraints): インペイントの modelPreset のサイズ制限とリドロープリセットを返します。不明なプリセットの場合はエラーではなく null のフィールドを返します。認証は不要です。 ### 動画 画像や参照素材から動画を生成します。 - [画像から動画を生成するタスクの作成](https://platform.pixai.art/ja/docs/api-v2/video/createFrameVideo): PixAI の Tsubaki 動画モデルで画像を動画にします。動画は firstFrameMediaId から始まり、lastFrameMediaId を指定した場合はその画像で終わります。出力は最初のフレームのアスペクト比を維持します。 - [参照動画生成タスクの作成](https://platform.pixai.art/ja/docs/api-v2/video/createReferenceVideo): 参照画像に基づいて動画を生成します。モデルによっては参照動画と参照音声も使用できます。 ### タスク タスクとその結果を取得します。 - [タスクの取得](https://platform.pixai.art/ja/docs/api-v2/task/getTask): 任意の v2 エンドポイントで作成したタスクを取得します。status が completed、failed、cancelled のいずれかになるまで、数秒ごとにポーリングしてください。 ### メディア 入力ファイルをアップロードし、メディア ID を URL に変換します。 - [ID によるメディア URL の取得](https://platform.pixai.art/ja/docs/api-v2/media/batchGetMedia): 最大 100 件のメディア ID を URL に解決します。完了したタスクの outputs.mediaIds や outputs.videoMediaId などに使います。公開メディアの場合、認証は不要です。 - [音声ファイルのアップロード URL の取得](https://platform.pixai.art/ja/docs/api-v2/media/getAudioUploadUrl): POST /v2/reference-video/create の referenceAudioMediaIds に使う音声クリップをアップロードする手順のステップ 1 です。流れは画像と同じです。ファイルの Content-Type(audio/mpeg または audio/wav)を付けてバイトを uploadUrl に PUT し、その後 POST /v2/media/audio/register を呼び出します。 - [画像のアップロード URL の取得](https://platform.pixai.art/ja/docs/api-v2/media/getImageUploadUrl): 入力として使う画像(contextImages の要素、動画のフレーム、インペイントのベース画像など)をアップロードする手順のステップ 1 です。 - [動画・音声ファイルの情報の取得](https://platform.pixai.art/ja/docs/api-v2/media/getMediaInfo): 動画または音声のメディアアイテムの長さ、サイズ、コンテナ、コーデックを返します。参照動画タスクを作成する前に、参照ファイルがモデルの制限を満たしているか確認できます。 - [アップロードした音声ファイルの登録](https://platform.pixai.art/ja/docs/api-v2/media/registerAudio): 音声クリップのアップロードのステップ 3 です。返される id が、referenceAudioMediaIds に渡すメディア ID です。 - [アップロードした画像の登録](https://platform.pixai.art/ja/docs/api-v2/media/registerImage): 画像アップロードのステップ 3 です。アップロードしたファイルをメディアアイテムにします。uploadUrl への PUT が成功した後に呼び出してください。返される id が、他のエンドポイントに渡すメディア ID です。 ### モデル モデル、LoRA、サイズ、カラーパレットを探します。 - [モデルまたは LoRA の取得](https://platform.pixai.art/ja/docs/api-v2/model/getGenerationModel): モデル ID(検索結果の id)で 1 つのモデルを取得します。 - [モデルバージョンの取得](https://platform.pixai.art/ja/docs/api-v2/model/getGenerationModelVersion): バージョン ID(生成エンドポイントが受け取る ID)で 1 つのモデルバージョンを取得します。生成前に LoRA のトリガーワードやベースモデルを調べるのに使います。 - [モデルバージョンが受け付けるサイズの取得](https://platform.pixai.art/ja/docs/api-v2/model/getModelSizeConfig): POST /v2/image/create の width/height にモデルバージョンが受け付けるサイズを一覧表示します。パスの名前に反して、パラメータはバージョン ID です。 - [カラーパレットプリセット一覧の取得](https://platform.pixai.art/ja/docs/api-v2/model/listColorPalettePresets): POST /v2/image/create の colorPalette に使う PixAI 公式カラーパレットを一覧表示します。使用するには、プリセットオブジェクト全体に "source": "preset" を追加して送信します。 - [モデルのバージョン一覧の取得](https://platform.pixai.art/ja/docs/api-v2/model/listGenerationModelVersions): モデルのバージョンを新しい順に一覧表示します。古いバージョンを固定して使うには、そのバージョンの id を modelVersionId または loras[].modelId として渡します。 - [モデルと LoRA の検索](https://platform.pixai.art/ja/docs/api-v2/model/searchGenerationModels): PixAI モデルマーケットを検索します。modelVersionId に使うベースモデルや、POST /v2/image/create の loras に使う LoRA を探すのに使います。 ## API ドキュメント タスク状態の取得と、ID によるメディアの取得・アップロードを行う v1 エンドポイント。 ### タスク 画像生成タスクの作成と管理に関する API エンドポイント。 - [タスク詳細の取得](https://platform.pixai.art/ja/docs/api/task/getTask): ID を指定して生成タスクを取得し、状態(waiting、running、completed、cancelled、failed)と、生成されたメディアの ID・URL を確認します。 ### メディア メディアをアップロードし、生成されたメディアを ID で取得するための API エンドポイント。 - [メディアの取得](https://platform.pixai.art/ja/docs/api/media/getMedia): ID を指定してメディアを取得し、種類、サイズ、各バリアントの URL を確認します。 - [IDでメディア画像へのリダイレクト](https://platform.pixai.art/ja/docs/api/media/getMediaImage): メディアの画像ファイルへ HTTP 302 でリダイレクトします。メディア ID をそのまま画像 URL として使えます。 - [画像・動画のアップロード](https://platform.pixai.art/ja/docs/api/media/uploadMedia): 画像または動画をアップロードしてメディア ID を取得します。メディア ID は保存されたファイルを識別します。 ## Extras 利用可能なモデル、Webhook 通知、サポートされている解像度などの追加リファレンス。 - [モデル](https://platform.pixai.art/ja/docs/references/models): PixAI 画像生成モデルの一覧(タイプ、バージョン、許可されたサンプリング方法) - [Webhook](https://platform.pixai.art/ja/docs/references/webhook): PixAI API のタスクが開始・完了・キャンセル・失敗したときに POST リクエストで通知を受け取れます。プロフィールの Webhook またはリクエストごとの callbackUrl で設定します。 - [対応解像度](https://platform.pixai.art/ja/docs/references/supported-resolutions): v2 API の 11 種類のアスペクト比ごとに、1k と 1.5k のサイズティアで出力される幅と高さ、およびデフォルト値をまとめています。 ## その他 著作権、ライセンス条件、フィードバック方法に関する情報。 - [著作権および関連する権利](https://platform.pixai.art/ja/docs/about/copyright): PixAI APIを通じて生成されたコンテンツの著作権、ライセンス条件、使用権について。 - [お問い合わせ](https://platform.pixai.art/ja/docs/about/feedback): PixAI API へのフィードバックやお問い合わせは、メールでお寄せください。 ## OpenAPI specs Machine-readable OpenAPI 3.1 specs of the endpoints above, for agents and client generators. - [API v2 spec](https://platform.pixai.art/openapi-spec.v2.ja.yaml): image and video generation, inpainting, uploads, tasks and model lookups, with every request field and error code. The English spec is also served as [/openapi.json](https://platform.pixai.art/openapi.json). - [API v1 spec](https://platform.pixai.art/openapi-spec.ja.yaml): task status, media lookup and media upload. ## Optional - [English index](https://platform.pixai.art/en/llms.txt): This index for the English pages. - [Korean index](https://platform.pixai.art/ko/llms.txt): This index for the Korean pages. - [Full documentation text](https://platform.pixai.art/llms-full.txt): Every docs page, in every language, as Markdown in one file.