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

# Flux Kontext 圖像生成

> 使用 Flux Kontext 模型進行圖片編輯和生成，支持文生圖和圖片編輯

* Flux Kontext 圖像生成與編輯模型
* 通過 model 參數選擇 `flux-kontext-pro`（Pro）或 `flux-kontext-max`（Max，更高質量）
* 支持文生圖、圖片編輯兩種模式
* 有參考圖時爲圖片編輯，無參考圖時爲文生圖
* 按請求固定計費
* 異步任務模式，返回 `task_id` 用於查詢結果

<Warning>
  **重要變更**：爲了更好的性能和成本控制，我們不再支持在 `image_urls` 中直接傳入 base64 圖片數據。請先使用 [上傳圖片接口](../../uploads/images) 上傳圖片，獲取 URL 後再調用本接口。
</Warning>

## Authorizations

<ParamField header="Authorization" type="string" required>
  所有接口均需要使用 Bearer Token 進行認證

  獲取 API Key：訪問 [API Key 管理頁面](https://toapis.com/console/token) 獲取您的 API Key

  使用時在請求頭中添加：

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

## Body

<ParamField body="model" type="string" required>
  圖像生成模型名稱

  可選值：

  * `flux-kontext-pro` - Pro 版本
  * `flux-kontext-max` - Max 版本，更高質量
</ParamField>

<ParamField body="prompt" type="string" required>
  圖像生成的文本描述
</ParamField>

<ParamField body="size" type="string">
  圖像寬高比

  默認值：

  * 有參考圖時：`match_input_image`（匹配輸入圖片）
  * 無參考圖時：`16:9`

  支持的寬高比：

  | 值                   | 說明               |
  | ------------------- | ---------------- |
  | `match_input_image` | 匹配輸入圖片比例（僅圖片編輯時） |
  | `1:1`               | 正方形              |
  | `4:3` / `3:4`       | 傳統顯示器比例          |
  | `16:9` / `9:16`     | 寬屏/豎屏            |
  | `3:2` / `2:3`       | 標準照片             |
  | `21:9` / `9:21`     | 超寬屏/超窄屏          |
</ParamField>

<ParamField body="image_urls" type="string[]">
  參考圖像 URL 數組，用於圖片編輯

  **⚠️ 僅支持 URL 格式（不支持 base64）**

  * 公開可訪問的圖片 URL（http\:// 或 https\://）
  * 可使用 [上傳圖片接口](../../uploads/images) 上傳本地圖片獲取 URL

  **限制：**

  * 最多 1 張圖片
  * 傳入圖片時爲圖片編輯模式，不傳時爲文生圖模式
</ParamField>

<ParamField body="metadata" type="object">
  元數據參數，用於傳遞額外的配置選項

  <Expandable title="支持的 metadata 字段">
    <ParamField body="response_format" type="string" default="png">
      輸出圖像格式

      可選值：`png`、`jpg`
    </ParamField>

    <ParamField body="safety_tolerance" type="integer" default={2}>
      安全過濾容忍度

      取值範圍：`0` - `6`，數值越高容忍度越高
    </ParamField>

    <ParamField body="prompt_upsampling" type="boolean" default={false}>
      是否啓用提示詞增強

      * `true`：自動優化/擴展提示詞
      * `false`：使用原始提示詞（默認）
    </ParamField>
  </Expandable>
</ParamField>

## Response

<ResponseField name="id" type="string">
  任務唯一標識符，用於查詢任務狀態
</ResponseField>

<ResponseField name="object" type="string">
  對象類型，固定爲 `generation.task`
</ResponseField>

<ResponseField name="model" type="string">
  使用的模型名稱
</ResponseField>

<ResponseField name="status" type="string">
  任務狀態

  * `queued` - 排隊等待處理
  * `in_progress` - 處理中
  * `completed` - 成功完成
  * `failed` - 失敗
</ResponseField>

<ResponseField name="progress" type="integer">
  任務進度百分比（0-100）
</ResponseField>

<ResponseField name="created_at" type="integer">
  任務創建時間戳（Unix 時間戳）
</ResponseField>

<ResponseField name="metadata" type="object">
  任務元數據
</ResponseField>

## 使用場景

### 場景一：文生圖

```json theme={null}
{
  "model": "flux-kontext-pro",
  "prompt": "賽博朋克風格的城市夜景，霓虹燈閃爍",
  "size": "16:9",
  "metadata": {
    "response_format": "png",
    "safety_tolerance": 2
  }
}
```

### 場景二：圖片編輯

```json theme={null}
{
  "model": "flux-kontext-max",
  "prompt": "將這張照片改爲水彩畫風格",
  "size": "match_input_image",
  "image_urls": ["https://example.com/photo.jpg"],
  "metadata": {
    "response_format": "jpg",
    "prompt_upsampling": true
  }
}
```

### 場景三：高質量文生圖（Max 模型）

```json theme={null}
{
  "model": "flux-kontext-max",
  "prompt": "一隻可愛的橘貓在窗臺上曬太陽，寫實風格",
  "size": "1:1",
  "metadata": {
    "response_format": "png",
    "safety_tolerance": 3
  }
}
```

<Note>
  **查詢任務結果**

  圖像生成爲異步任務，提交後會返回任務 ID。使用 [獲取圖像任務狀態](../../tasks/image-status) 接口查詢生成進度和結果。
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://toapis.com/v1/images/generations \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "model": "flux-kontext-pro",
      "prompt": "賽博朋克風格的城市夜景，霓虹燈閃爍",
      "size": "16:9",
      "metadata": {
        "response_format": "png"
      }
    }'
  ```

  ```bash cURL (圖片編輯) theme={null}
  curl --request POST \
    --url https://toapis.com/v1/images/generations \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "model": "flux-kontext-max",
      "prompt": "將這張照片改爲水彩畫風格",
      "size": "match_input_image",
      "image_urls": ["https://example.com/photo.jpg"],
      "metadata": {
        "response_format": "jpg"
      }
    }'
  ```

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

  response = requests.post(
      "https://toapis.com/v1/images/generations",
      headers={
          "Authorization": "Bearer your-ToAPIs-key",
          "Content-Type": "application/json"
      },
      json={
          "model": "flux-kontext-pro",
          "prompt": "賽博朋克風格的城市夜景，霓虹燈閃爍",
          "size": "16:9",
          "metadata": {
              "response_format": "png"
          }
      }
  )

  task = response.json()
  print(f"任務 ID: {task['id']}")
  print(f"狀態: {task['status']}")
  ```

  ```python Python (圖片編輯) theme={null}
  import requests

  response = requests.post(
      "https://toapis.com/v1/images/generations",
      headers={
          "Authorization": "Bearer your-ToAPIs-key",
          "Content-Type": "application/json"
      },
      json={
          "model": "flux-kontext-max",
          "prompt": "將這張照片改爲水彩畫風格",
          "size": "match_input_image",
          "image_urls": ["https://example.com/photo.jpg"],
          "metadata": {
              "response_format": "jpg"
          }
      }
  )

  task = response.json()
  print(f"任務 ID: {task['id']}")
  print(f"狀態: {task['status']}")
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://toapis.com/v1/images/generations', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer your-ToAPIs-key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      model: 'flux-kontext-pro',
      prompt: '賽博朋克風格的城市夜景，霓虹燈閃爍',
      size: '16:9',
      metadata: {
        response_format: 'png'
      }
    })
  });

  const task = await response.json();
  console.log(`任務 ID: ${task.id}`);
  console.log(`狀態: ${task.status}`);
  ```

  ```javascript JavaScript (圖片編輯) theme={null}
  const response = await fetch('https://toapis.com/v1/images/generations', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer your-ToAPIs-key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      model: 'flux-kontext-max',
      prompt: '將這張照片改爲水彩畫風格',
      size: 'match_input_image',
      image_urls: ['https://example.com/photo.jpg'],
      metadata: {
        response_format: 'jpg'
      }
    })
  });

  const task = await response.json();
  console.log(`任務 ID: ${task.id}`);
  console.log(`狀態: ${task.status}`);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "task_img_abc123def456",
    "object": "generation.task",
    "model": "flux-kontext-pro",
    "status": "queued",
    "progress": 0,
    "created_at": 1703884800,
    "metadata": {}
  }
  ```
</ResponseExample>