画像生成タスクの作成

簡略化された v2 API を使って新しい画像の生成を開始します。 v2 API は `aspectRatio`（アスペクト比）、`mode`（品質モード）、名前付き `style` プリセットなど、ユーザーフレンドリーなパラメータを提供します。v1 の生ピクセル寸法や内部パラメータ名を置き換えます。

Authorization

bearerAuth

AuthorizationBearer <token>

認証が必要なすべてのリクエストでは、HTTP ヘッダーに次を追加してください

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

modelVersionId*string

生成に使用するモデルバージョンの一意の識別子です。非推奨の modelId フィールドの代替として推奨されます。

modelVersionId の見つけ方:

PixAI のモデルページを開きます。
使用したいモデルバージョンをクリックします。
URL の末尾のパスセグメントをコピーします。これが modelVersionId です。

URL 例: https://pixai.art/model/<id>-<slug>/<modelVersionId> → modelVersionId は <modelVersionId> です。

Length1 <= length

prompt*string

生成したいコンテンツを説明するメインプロンプトです。

Length1 <= length

negativePrompt?string

生成画像に含めたくない要素を説明するテキストです。

aspectRatio?string

生成画像のアスペクト比。デフォルトは 1:1 です。

利用可能な比率: 1:1, 2:3, 3:2, 3:4, 4:3, 3:5, 5:3, 9:16, 16:9, 1:3, 3:1

すべての比率はすべてのモデルタイプ（SDXL、DiT、Tsubaki.2）で利用可能です。

サイズティアごとの完全な解像度マッピングは対応解像度を参照してください。

Default"1:1"

Value in"1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "3:5" | "5:3" | "9:16" | "16:9" | "1:3" | "3:1"

size?string

出力解像度のティア。1.5k の最長辺は 1536 px です。

1k: 約 1 メガピクセル（例: 1:1 で 1024×1024）。
1.5k: 約 2.36 メガピクセル（例: 1:1 で 1536×1536）。

完全なマッピングテーブルは対応解像度を参照してください。

Default"1k"

Value in"1k" | "1.5k"

mode?stringTsubaki.2 専用

生成品質と速度を制御する推論プロファイルです。

lite: 最速、基本品質。
standard: 速度と品質のバランス（デフォルト）。
pro: 高品質、低速。
ultra: 最高品質、最低速。

Default"standard"

Value in"lite" | "standard" | "pro" | "ultra"

style?|Tsubaki.2 専用

生成中に適用するスタイルです。名前付きプリセットまたはカスタムスタイル文字列を指定できます。

loras?array<>

出力スタイルやコンテンツを微調整するための LoRA アダプターです。最大 5 つ組み合わせて使用できます。

LoRA modelId の見つけ方:

PixAI で LoRA モデルページを開きます。
使用したい LoRA バージョンをクリックします。
URL の末尾のパスセグメントをコピーします。これが LoRA バージョン ID です。

URL 例: https://pixai.art/model/<loraModelId>/<loraVersionId> → LoRA バージョン ID は <loraVersionId> です。

Itemsitems <= 5

seed?integer

再現性のある生成のためのランダムシードです。省略するとランダムに生成されます。

sampling?SDXL / SD v1 向け

拡散プロセスを微調整するための高度なサンプリングパラメータです。すべてのフィールドは省略可能で、省略した場合はモデルのデフォルト値が使用されます。

モデルごとの対応サンプリングメソッドはモデル一覧ページを参照してください。

promptHelper?string

生成前にプロンプトを自動強化する組み込みプロンプトヘルパーを使用するかどうかを指定します。

enable: プロンプトを自動的に強化します（デフォルト）。
disable: プロンプトをそのまま使用します。

Default"enable"

Value in"enable" | "disable"

callbackUrl?string

タスクのステータス更新を受け取るための公開 URL（Webhook）です。

タスクのステータスが変化した際に、この URL に POST リクエストが送信されます。

Formaturi

Response Body

`application/json`

curl -X POST "https://api.pixai.art/v2/image/create" \  -H "Content-Type: application/json" \  -d '{    "modelVersionId": "1983308862240288769",    "prompt": "1girl, green hair, solo, standing",    "aspectRatio": "9:16",    "mode": "standard"  }'

{
  "id": "string",
  "status": "waiting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "startedAt": "2019-08-24T14:15:22Z",
  "endAt": "2019-08-24T14:15:22Z",
  "outputs": {
    "mediaIds": [
      "string"
    ],
    "mediaUrls": [
      "string"
    ]
  }
}

Empty

画像生成タスクの作成

Authorization

Request Body

Response Body

201application/json

401

500

`application/json`