> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GPT-Image-2 公式チャネル 画像生成

>  - OpenAI 公式 `gpt-image-2` モデル、`/v1/images/generations` 互換プロトコルベース
- 非同期処理モード、`task_id` を返却して後続クエリで使用
- テキストから画像 / 画像から画像 / インペインティング（mask）の 3-in-1
- 新規 `resolution` ティアフィールド、1K / 2K / 4K の選択をサポート
- 15 種の比率をサポートし、1K / 2K / 4K ティアで利用できます
- 1 リクエストあたり最大 4 枚、参照画像は最大 16 枚
- `gpt-image-1.5-official` とパラメータが 95% 一致、移行はモデル名の変更のみで完了 

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.apimart.ai/v1/images/generations \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "model": "gpt-image-2-official",
      "prompt": "星空の下の古代の城",
      "size": "16:9",
      "resolution": "2k",
      "quality": "high",
      "n": 1
    }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.apimart.ai/v1/images/generations"

  payload = {
      "model": "gpt-image-2-official",
      "prompt": "星空の下の古代の城",
      "size": "16:9",
      "resolution": "2k",
      "quality": "high",
      "n": 1
  }

  headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const url = "https://api.apimart.ai/v1/images/generations";

  const payload = {
    model: "gpt-image-2-official",
    prompt: "星空の下の古代の城",
    size: "16:9",
    resolution: "2k",
    quality: "high",
    n: 1,
  };

  const headers = {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  };

  fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(payload),
  })
    .then((response) => response.json())
    .then((data) => console.log(data))
    .catch((error) => console.error("Error:", error));
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
  )

  func main() {
      url := "https://api.apimart.ai/v1/images/generations"

      payload := map[string]interface{}{
          "model":      "gpt-image-2-official",
          "prompt":     "星空の下の古代の城",
          "size":       "16:9",
          "resolution": "2k",
          "quality":    "high",
          "n":          1,
      }

      jsonData, _ := json.Marshal(payload)

      req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
      req.Header.Set("Authorization", "Bearer <token>")
      req.Header.Set("Content-Type", "application/json")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      fmt.Println(string(body))
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://api.apimart.ai/v1/images/generations";

          String payload = """
          {
            "model": "gpt-image-2-official",
            "prompt": "星空の下の古代の城",
            "size": "16:9",
            "resolution": "2k",
            "quality": "high",
            "n": 1
          }
          """;

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer <token>")
              .header("Content-Type", "application/json")
              .POST(HttpRequest.BodyPublishers.ofString(payload))
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $url = "https://api.apimart.ai/v1/images/generations";

  $payload = [
      "model" => "gpt-image-2-official",
      "prompt" => "星空の下の古代の城",
      "size" => "16:9",
      "resolution" => "2k",
      "quality" => "high",
      "n" => 1
  ];

  $ch = curl_init($url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer <token>",
      "Content-Type: application/json"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  url = URI("https://api.apimart.ai/v1/images/generations")

  payload = {
    model: "gpt-image-2-official",
    prompt: "星空の下の古代の城",
    size: "16:9",
    resolution: "2k",
    quality: "high",
    n: 1
  }

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(url)
  request["Authorization"] = "Bearer <token>"
  request["Content-Type"] = "application/json"
  request.body = payload.to_json

  response = http.request(request)
  puts response.body
  ```

  ```swift Swift theme={null}
  import Foundation

  let url = URL(string: "https://api.apimart.ai/v1/images/generations")!

  let payload: [String: Any] = [
      "model": "gpt-image-2-official",
      "prompt": "星空の下の古代の城",
      "size": "16:9",
      "resolution": "2k",
      "quality": "high",
      "n": 1
  ]

  var request = URLRequest(url: url)
  request.httpMethod = "POST"
  request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
  request.setValue("application/json", forHTTPHeaderField: "Content-Type")
  request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }

      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var url = "https://api.apimart.ai/v1/images/generations";

          var payload = @"{
              ""model"": ""gpt-image-2-official"",
              ""prompt"": ""星空の下の古代の城"",
              ""size"": ""16:9"",
              ""resolution"": ""2k"",
              ""quality"": ""high"",
              ""n"": 1
          }";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

          var content = new StringContent(payload, Encoding.UTF8, "application/json");
          var response = await client.PostAsync(url, content);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```

  ```dart Dart theme={null}
  import 'dart:convert';
  import 'package:http/http.dart' as http;

  void main() async {
    final url = Uri.parse('https://api.apimart.ai/v1/images/generations');

    final payload = {
      'model': 'gpt-image-2-official',
      'prompt': '星空の下の古代の城',
      'size': '16:9',
      'resolution': '2k',
      'quality': 'high',
      'n': 1,
    };

    final response = await http.post(
      url,
      headers: {
        'Authorization': 'Bearer <token>',
        'Content-Type': 'application/json',
      },
      body: jsonEncode(payload),
    );

    print(response.body);
  }
  ```

  ```r R theme={null}
  library(httr)
  library(jsonlite)

  url <- "https://api.apimart.ai/v1/images/generations"

  payload <- list(
    model = "gpt-image-2-official",
    prompt = "星空の下の古代の城",
    size = "16:9",
    resolution = "2k",
    quality = "high",
    n = 1
  )

  response <- POST(
    url,
    add_headers(
      Authorization = "Bearer <token>",
      `Content-Type` = "application/json"
    ),
    body = toJSON(payload, auto_unbox = TRUE),
    encode = "raw"
  )

  cat(content(response, "text"))
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": [
      {
        "status": "submitted",
        "task_id": "task_01KPTXXXXXXXXXXXXXXX"
      }
    ]
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "code": 400,
      "message": "パラメータエラー：size が不正 / resolution が未対応 / ピクセル違反など",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "認証に失敗しました。API キーをご確認ください",
      "type": "authentication_error"
    }
  }
  ```

  ```json 402 theme={null}
  {
    "error": {
      "code": 402,
      "message": "アカウント残高が不足しています。チャージ後に再試行してください",
      "type": "payment_required"
    }
  }
  ```

  ```json 403 theme={null}
  {
    "error": {
      "code": 403,
      "message": "アクセスが禁止されています。このリソースへの権限がありません",
      "type": "permission_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "リクエストが多すぎます。しばらくしてから再試行してください",
      "type": "rate_limit_error"
    }
  }
  ```

  ```json 500 theme={null}
  {
    "error": {
      "code": 500,
      "message": "サーバー内部エラー、しばらくしてから再試行してください",
      "type": "server_error"
    }
  }
  ```

  ```json 502 theme={null}
  {
    "error": {
      "code": 502,
      "message": "ゲートウェイエラー、サーバーが一時的に利用できません",
      "type": "bad_gateway"
    }
  }
  ```
</ResponseExample>

## Authorizations

<ParamField header="Authorization" type="string" required>
  すべてのエンドポイントは Bearer Token による認証が必要です

  API キーの取得：

  [API キー管理ページ](https://apimart.ai/keys) にアクセスして API キーを取得してください

  使用時はリクエストヘッダーに以下を追加：

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Body

<ParamField body="model" type="string" default="gpt-image-2-official" required>
  画像生成モデル名

  `gpt-image-2-official` に固定（OpenAI 公式 gpt-image-2 モデル）
</ParamField>

<ParamField body="prompt" type="string" required>
  画像生成のテキスト記述

  * 日本語・英語・中国語をサポート、詳細な記述を推奨
  * 送信前にプラットフォームのセンシティブワード / セーフティレビューを通過します。違反内容は即座にエラーを返します
</ParamField>

<ParamField body="size" type="string" default="1:1">
  画像の比率

  対外的には比率値を使用し、システム内部で `resolution` に基づいて具体的なピクセルに自動マッピングされます。

  以下の比率をサポート、さらに `auto` を指定するとサーバー側で適切な比率を自動選択します：

  * `auto` - 自動（prompt / 参照画像に基づきサーバー側が比率を選択）
  * `1:1` - 正方形（デフォルト、SNS アバター / ロゴ）
  * `3:2` - 横構図（一眼レフでよく使われる比率）
  * `2:3` - 縦構図（縦長ポスター）
  * `4:3` - 横構図（クラシックモニター / スライド）
  * `3:4` - 縦構図
  * `5:4` - 横構図
  * `4:5` - 縦構図（Instagram 縦型投稿）
  * `16:9` - 横構図（ワイド動画サムネイル）
  * `9:16` - 縦構図（スマホフルスクリーン / ショート動画カバー）
  * `2:1` - 横構図（Web バナー）
  * `1:2` - 縦構図
  * `3:1` - 横構図（ウルトラワイドバナー）
  * `1:3` - 縦構図（超縦長ポスター）
  * `21:9` - 横構図（映画ウルトラワイド）
  * `9:21` - 縦構図

  `1881x836` / `887x1774` のようなピクセルサイズも直接指定できます。

  <Warning>
    `size` に `auto` を指定した場合、デフォルトの比率は `1:1` です。
  </Warning>
</ParamField>

<ParamField body="resolution" type="string" default="1k">
  解像度ティア（**新規フィールド**）

  実際の出力解像度を制御します。

  * `1k` - 1024 ベースライン、日常利用でコスト効率が良い（デフォルト）
  * `2k` - 2048 ベースライン、ポスター / 高精細用途に適する
  * `4k` - 3840 ベースライン、下記マッピング表の 15 種の比率をサポート

  <Warning>
    4K は下記マッピング表の 15 種の比率をサポートします。表内のピクセルサイズを `size` で直接指定することもできます。
  </Warning>
</ParamField>

<ParamField body="quality" type="string" default="auto">
  画像品質

  * `auto` - 自動（デフォルト、通常 `low` に相当）
  * `low` - 高速で低コスト、ラフスケッチで十分
  * `medium` - バランス型
  * `high` - 最高精度（4K + high は 120 秒以上かかる場合あり）
</ParamField>

<ParamField body="background" type="string" default="auto">
  背景モード

  * `auto` - 自動（デフォルト）
  * `opaque` - 不透明
  * `transparent` - ⚠️ **gpt-image-2-official は透過背景をサポートしません。指定してもシステムは静かに `auto` にダウングレードします**
</ParamField>

<ParamField body="moderation" type="string" default="auto">
  モデレーション強度

  * `auto` - デフォルトモデレーション強度
  * `low` - より緩やかなモデレーション
</ParamField>

<ParamField body="output_format" type="string" default="png">
  出力フォーマット

  * `png` - デフォルト
  * `jpeg` - ファイルサイズが小さい
  * `webp` - モダンブラウザ向け最適
</ParamField>

<ParamField body="output_compression" type="integer">
  出力圧縮レベル、範囲 `0-100`

  * `jpeg` / `webp` のみ有効
</ParamField>

<ParamField body="n" type="integer" default="1">
  生成する画像の枚数

  範囲：`1 ~ 4`

  <Warning>
    必ず数値（例：`1`）を入力してください。引用符で囲まないでください
  </Warning>
</ParamField>

<ParamField body="image_urls" type="array">
  参照画像 URL 配列

  <Expandable title="詳細">
    * 1 枚あたり最大 20 MB、合計上限 256 MB
    * 参照画像は最大 **16 枚**、超過すると拒否されます
    * 公開アクセス可能な安定した画像 URL である必要があります
  </Expandable>
</ParamField>

<ParamField body="mask_url" type="string">
  マスク画像 URL、インペインティング用

  * `image_urls` と併用する必要があります

  <Warning>
    1. マスク画像をアップロードする前に、Alpha チャンネルが「はい」であることを確認してください。

    2. マスク画像のサイズは **最初の参照画像と一致** する必要があります。
  </Warning>
</ParamField>

## サイズ × 解像度マッピング表

`size × resolution` → OpenAI 実ピクセル（15 比率 × 3 ティア）：

| size   | `1k`                | `2k`      | `4k`          |
| ------ | ------------------- | --------- | ------------- |
| `1:1`  | 1024×1024           | 2048×2048 | **2880×2880** |
| `3:2`  | 1536×1024           | 2048×1360 | **3520×2336** |
| `2:3`  | 1024×1536           | 1360×2048 | **2336×3520** |
| `4:3`  | 1024×768            | 2048×1536 | **3312×2480** |
| `3:4`  | 768×1024            | 1536×2048 | **2480×3312** |
| `5:4`  | 1280×1024           | 2560×2048 | **3216×2576** |
| `4:5`  | 1024×1280           | 2048×2560 | **2576×3216** |
| `16:9` | 1536×864            | 2048×1152 | **3840×2160** |
| `9:16` | 864×1536            | 1152×2048 | **2160×3840** |
| `2:1`  | 2048×1024           | 2688×1344 | **3840×1920** |
| `1:2`  | 1024×2048           | 1344×2688 | **1920×3840** |
| `3:1`  | 1881×836 / 1536×512 | 3072×1024 | **3840×1280** |
| `1:3`  | 887×1774 / 512×1536 | 1024×3072 | **1280×3840** |
| `21:9` | 2016×864            | 2688×1152 | **3840×1648** |
| `9:21` | 864×2016            | 1152×2688 | **1648×3840** |

> 備考：一部のサイズは 16 の倍数とピクセル上限に基づいて近似マッピングされます。例：`3:2` / `2:3` @ 2K は 2048×1360、`21:9` @ 4K は 3840×1648 です。実際のピクセルは表の値を基準にしてください。

## 使用シナリオ例

**テキストから画像（最小リクエスト）**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "星空の下の古代の城"
}
```

**2K 高精細ポスター**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "サイバーパンクの夜景",
  "size": "16:9",
  "resolution": "2k",
  "quality": "high",
  "output_format": "jpeg",
  "output_compression": 90
}
```

**4K 壁紙**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "雪山の日の出パノラマ",
  "size": "16:9",
  "resolution": "4k",
  "quality": "high",
  "n": 1
}
```

**画像から画像（複数参照画像の融合）**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "2 枚の参照画像を 1 枚のイラストポスターに融合し、主体の輪郭を保持する",
  "size": "1:1",
  "quality": "high",
  "image_urls": [
    "https://your-cdn.com/input-a.png",
    "https://your-cdn.com/input-b.png"
  ]
}
```

**インペインティング（mask）**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "背景を砂漠の夕日に置き換える",
  "size": "1:1",
  "quality": "medium",
  "image_urls": ["https://your-cdn.com/photo.png"],
  "mask_url": "https://your-cdn.com/mask.png"
}
```

**複数枚生成（n > 1）**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "Four minimalist poster variations of a red fox",
  "size": "1:1",
  "quality": "low",
  "n": 4
}
```

**ピクセル文字列の直接指定（上級利用）**

```json theme={null}
{
  "model": "gpt-image-2-official",
  "prompt": "wide cinematic shot",
  "size": "3840x2160",
  "quality": "high"
}
```

## Response

<ResponseField name="code" type="integer">
  レスポンスステータスコード
</ResponseField>

<ResponseField name="data" type="array">
  レスポンスデータ配列

  <Expandable title="プロパティ">
    <ResponseField name="status" type="string">
      タスクステータス

      * `submitted` - 提出済み
    </ResponseField>

    <ResponseField name="task_id" type="string">
      タスクの一意識別子。後続の結果クエリに使用します
    </ResponseField>
  </Expandable>
</ResponseField>

## タスク結果のクエリ

提出成功後に `task_id` が返されます。`GET /v1/tasks/{task_id}` でタスク状態をポーリングしてください。詳細は [タスククエリ API](/ja/api-reference/tasks/status) を参照。

### 成功レスポンス例

```json theme={null}
{
  "code": 200,
  "data": {
    "actual_time": 14,
    "completed": 1784607890,
    "cost": 0.004792,
    "created": 1784607876,
    "credits_cost": 0.047920000000000004,
    "estimated_time": 60,
    "id": "task_01KPTXXXXXXXXXXXXXXX",
    "progress": 100,
    "result": {
      "images": [
        {
          "expires_at": 1784694290,
          "url": [
            "https://upload.apimart.ai/f/image/xxxxxxxx-gpt_image_2_official_task_xxx_0.png"
          ]
        }
      ]
    },
    "status": "completed",
    "usage": {
      "input_tokens": 22,
      "input_tokens_details": {
        "cached_tokens": 0,
        "image_tokens": 0,
        "text_tokens": 22
      },
      "output_tokens": 196,
      "output_tokens_details": {
        "image_tokens": 196,
        "text_tokens": 0
      },
      "total_tokens": 218
    }
  }
}
```

`usage` フィールドはこのリクエストの課金対象トークン使用量を示します：

| フィールド                                | 説明                                            |
| ------------------------------------ | --------------------------------------------- |
| `input_tokens`                       | 入力で消費したトークンの合計                                |
| `input_tokens_details.cached_tokens` | キャッシュから提供された入力トークン数                           |
| `input_tokens_details.image_tokens`  | 入力画像が使用したトークン数                                |
| `input_tokens_details.text_tokens`   | 入力テキスト（プロンプト）が使用したトークン数                       |
| `output_tokens`                      | 出力で消費したトークンの合計                                |
| `output_tokens_details.image_tokens` | 生成された画像が使用したトークン数                             |
| `output_tokens_details.text_tokens`  | 出力テキストが使用したトークン数                              |
| `total_tokens`                       | トークンの合計。`input_tokens` + `output_tokens` に等しい |

画像生成では出力の大半が画像トークンのため、`output_tokens_details.image_tokens` は通常 `output_tokens` と等しくなります。上の例では `total_tokens` = 22 + 196 = 218 です。

タスクステータスフロー：`submitted` → `in_progress` → `completed` / `failed`。

画像の取得：`data.result.images[0].url[0]`。
