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

# Flux Kontext

> FLUX.1 Kontext API 可使用 Pro 或 Max 根据文本生成图像，或编辑一张参考图。宽高比范围为 21:9 到 9:21，编辑请求只使用第一个图像 URL。

> [!TIP]
>
> 1. 提交后会返回 `task_id`。如果提供了 `callback_url`，当任务状态变为 `finished` 或 `failed` 时，系统会向 `callback_url` 发送 POST 请求。
> 2. 无论是否提供 `callback_url`，都可以通过统一的[查询任务状态](https://docs.poyo.ai/zh/api-manual/task-management/status.md)接口获取结果。

Flux Kontext 由 Black Forest Labs 提供支持。它通过同一个统一提交接口同时支持文生图和图像编辑。

## 模型

* **flux-kontext-pro** - Flux Kontext Pro 文生图
* **flux-kontext-pro-edit** - Flux Kontext Pro 图像编辑，`image_urls` 必填
* **flux-kontext-max** - Flux Kontext Max 文生图
* **flux-kontext-max-edit** - Flux Kontext Max 图像编辑，`image_urls` 必填

## 注意事项

* `size` 支持 `1:1`、`4:3`、`3:4`、`16:9`、`9:16`、`21:9`、`9:21`
* `output_format` 支持 `png`、`jpg`
* 编辑模型必须提供 `image_urls`
* 只有 `image_urls[0]` 会被用作输入图像
* 其他下游字段在当前 API 中未开放，使用系统默认值


## OpenAPI

````yaml zh/api-manual/image-series/flux-kontext.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: PoYo AI - Flux Kontext API
  description: >-
    FLUX.1 Kontext API 使用 Pro 或 Max 根据文本生成图像，或编辑一张参考图像。宽高比范围从 21:9 到
    9:21，编辑请求只使用第一个图像 URL。
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Flux Kontext
      summary: 提交 Flux Kontext 生成任务
      description: 通过统一提交接口使用 Flux Kontext 模型生成或编辑图像
      operationId: submitFluxKontextTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              flux-kontext-pro:
                summary: Flux Kontext Pro 图像生成
                value:
                  model: flux-kontext-pro
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      A luxury perfume bottle on a reflective marble surface,
                      premium studio lighting
                    size: '16:9'
                    output_format: png
              flux-kontext-pro-edit:
                summary: Flux Kontext Pro 图像编辑
                value:
                  model: flux-kontext-pro-edit
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      Replace the background with a clean warm gradient studio
                      backdrop
                    image_urls:
                      - https://example.com/reference.jpg
                    size: '1:1'
                    output_format: jpg
              flux-kontext-max:
                summary: Flux Kontext Max 图像生成
                value:
                  model: flux-kontext-max
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      A premium wristwatch product photo with dramatic soft
                      shadows and metallic highlights
                    size: '4:3'
                    output_format: png
              flux-kontext-max-edit:
                summary: Flux Kontext Max 图像编辑
                value:
                  model: flux-kontext-max-edit
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: Change the background into a minimal teal studio scene
                    image_urls:
                      - https://example.com/reference.jpg
                    size: '1:1'
                    output_format: jpg
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: 请求参数无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 400
                error:
                  message: Invalid request parameters
                  type: invalid_request_error
        '401':
          description: 未授权：API Key 无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 401
                error:
                  message: Unauthorized - Invalid API key
                  type: authentication_error
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: Flux Kontext 模型标识
          enum:
            - flux-kontext-pro
            - flux-kontext-pro-edit
            - flux-kontext-max
            - flux-kontext-max-edit
        callback_url:
          type: string
          format: uri
          description: 接收结果通知的 Webhook 回调 URL
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
          description: 生成参数
          properties:
            prompt:
              type: string
              description: 描述期望输出的生成或编辑提示词
              maxLength: 2000
              example: A beautiful sunset over the ocean
            image_urls:
              type: array
              items:
                type: string
                format: uri
              minItems: 1
              maxItems: 1
              description: >-
                输入图像
                URL。编辑模型（flux-kontext-pro-edit、flux-kontext-max-edit）必填。仅使用第一张图像。
              example:
                - https://example.com/reference.jpg
            size:
              type: string
              description: 输出宽高比。省略时默认为 1:1。
              enum:
                - '1:1'
                - '4:3'
                - '3:4'
                - '16:9'
                - '9:16'
                - '21:9'
                - '9:21'
              default: '1:1'
              example: '16:9'
            output_format:
              type: string
              description: 输出图像格式。
              enum:
                - png
                - jpg
              example: png
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
              description: 任务唯一标识，用于查询任务状态
            status:
              type: string
              enum:
                - not_started
                - running
                - finished
                - failed
              example: not_started
              description: >-
                任务状态。提交后立即返回时始终为
                `not_started`。后续状态请通过[查询任务状态](/zh/api-manual/task-management/status)接口或
                `callback_url` 获取。


                - `not_started`：排队中，等待处理

                - `running`：生成中

                - `finished`：已完成，结果在 `files` 或 `output` 中

                - `failed`：失败，详情见 `error_message`
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
              description: 任务创建时间，ISO 8601 格式
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
              description: 描述错误原因的错误信息
            type:
              type: string
              example: invalid_request_error
              description: 错误类型标识
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        所有 API 接口都需要 Bearer Token 认证。


        创建 API Key：登录 PoYo，进入 **仪表盘 → API
        密钥**（[poyo.ai/zh/dashboard/api-key](https://poyo.ai/zh/dashboard/api-key)），点击创建
        Key。


        在请求头中添加：


        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.