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

# Flux Kontext Pro Edit

> Edit images with FLUX Kontext Pro using text instructions, with support for character consistency and changes to specific visual details.

<Tip>
  1. Submit the request with `VIDGO_API_KEY`. A `task_id` is returned immediately. Keep it until the task reaches `finished` or `failed`.
  2. Use [Query Task Status](/api-manual/task-management/status) to retrieve the result. If you provide a `callback_url`, Vidgo sends the result to your [webhook](/api-manual/task-management/webhooks) when the task finishes or fails.
</Tip>

# Flux Kontext Pro Edit

Edit images with FLUX Kontext Pro using text instructions, with support for character consistency and changes to specific visual details.

## Available Models

* **blackforestlabs/flux-kontext-pro** - Edit one source image with a text prompt.

## Output Options

### Image Size

* `size`: Optional. Output aspect ratio. Accepted values: `1:1`, `4:3`, `3:4`, `16:9`, `9:16`, `21:9`, `9:21`. Default: `1:1`.

### Output Format

* `output_format`: Optional. Output image file format. Accepted values: `png`, `jpg`.

## Key Features

* Edit one source image with a text prompt.
* Provide the source image as a single item in `image_urls`.

## Advanced Parameters

Set `model` and optional `callback_url` at the request root. Place all workflow parameters, including output options, inside `input`.

Input image URLs use HTTP(S) and point to publicly accessible image files.

### Prompt

* `prompt`: Required. Describe the requested changes. Length: **1-2,000 characters**.
* Include at least one non-whitespace character.

### Image URLs

* `image_urls`: Required. Provide exactly 1 publicly accessible HTTP(S) image URL as the source image.

## Verified Example

This example was generated through the Vidgo API and is also the default example in the playground. Source and result images are hosted on the Vidgo CDN.

![Source image 1](https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/02/input-01.png)

![Renaming a Fishing Boat in Chiloé](https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/02/output.jpg)

```json theme={null}
{
  "code": 200,
  "data": {
    "task_id": "KH8OWRITIOASWYGA",
    "status": "finished",
    "files": [
      {
        "file_type": "image",
        "file_url": "https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/02/output.jpg"
      }
    ],
    "created_time": "2026-09-26T11:02:37",
    "error_message": null,
    "progress": 100
  }
}
```


## OpenAPI

````yaml api-manual/image-series/blackforestlabs-flux-kontext-pro.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Flux Kontext Pro Edit
  description: >-
    Edit images with FLUX Kontext Pro using text instructions, with support for
    character consistency and changes to specific visual details.
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Image Series
      summary: Flux Kontext Pro Edit
      description: >-
        Submit a Flux Kontext Pro Edit task with model and optional callback_url
        at the request root, and generation parameters inside input.
      operationId: submit_blackforestlabs_flux_kontext_pro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
                - input
              additionalProperties: true
              properties:
                model:
                  type: string
                  example: blackforestlabs/flux-kontext-pro
                  enum:
                    - blackforestlabs/flux-kontext-pro
                input:
                  type: object
                  required:
                    - image_urls
                    - prompt
                  properties:
                    prompt:
                      type: string
                      maxLength: 2000
                      minLength: 1
                      description: >-
                        Describe the requested image changes using 1–2,000
                        characters, including at least one non-whitespace
                        character.
                    image_urls:
                      type: array
                      items:
                        type: string
                        format: uri
                        description: Publicly accessible HTTP(S) image URL.
                      minItems: 1
                      maxItems: 1
                      description: >-
                        Source image to edit. Supply exactly 1 publicly
                        accessible HTTP(S) image URL.
                    size:
                      type: string
                      enum:
                        - '1:1'
                        - '4:3'
                        - '3:4'
                        - '16:9'
                        - '9:16'
                        - '21:9'
                        - '9:21'
                      default: '1:1'
                      description: Output aspect ratio. Defaults to 1:1.
                    output_format:
                      type: string
                      enum:
                        - png
                        - jpg
                      description: 'Output image file format: png or jpg.'
                  additionalProperties: false
                callback_url:
                  type: string
                  nullable: true
                  description: >-
                    Public HTTP(S) URL that receives a POST notification when
                    the task reaches finished or failed.
              description: >-
                Set model and optional callback_url at the request root. Place
                generation parameters inside input.
            examples:
              default:
                summary: Renaming a Fishing Boat in Chiloé
                value:
                  model: blackforestlabs/flux-kontext-pro
                  input:
                    prompt: >-
                      Replace the painted name on the bow "MARISOL" with
                      "ALBATROS". Paint the new letters in the same hand-painted
                      white capital lettering style, same size, same brush
                      texture, with the same chipping and weathering as the rest
                      of the hull. Keep everything else unchanged: the boat, its
                      sky blue hull and white stripe, the rope and buoy, the
                      pebble beach, the palafito stilt houses, the hills, the
                      overcast light and the camera framing.
                    image_urls:
                      - >-
                        https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/02/input-01.png
                    size: '16:9'
                    output_format: jpg
              pro-edit-01:
                summary: Backstrap Loom by Lamplight
                value:
                  model: blackforestlabs/flux-kontext-pro
                  input:
                    prompt: >-
                      Change the time of day from bright midday to late night.
                      The only light source is now a single old tin oil lantern
                      with a warm flickering flame, placed on the ground to the
                      left of the woman, casting warm orange light across her
                      face, hands and the textile and long soft shadows on the
                      wall. The sky above the courtyard becomes deep navy with a
                      few stars, the turquoise door and bougainvillea fall
                      mostly into shadow. Keep everything else exactly the same:
                      the woman's face, expression, pose, braid with red
                      ribbons, embroidered huipil, the exact position of her
                      hands on the batten, the diamond pattern of the textile,
                      the loom, the post, the clay jar and the camera framing.
                    image_urls:
                      - >-
                        https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/01/input-01.png
                    size: '4:3'
                    output_format: png
              pro-edit-03:
                summary: Clearing a Marrakech Riad Courtyard
                value:
                  model: blackforestlabs/flux-kontext-pro
                  input:
                    prompt: >-
                      Remove the stacked white plastic chairs, the yellow
                      bucket, the grey mop and the green garden hose. Fill in
                      the areas behind them with the matching zellige mosaic
                      fountain tiles and patterned floor tiles, continuing the
                      existing geometric pattern and the diagonal late-afternoon
                      light and shadows. Keep the fountain, the water, the
                      arches, the carved balconies, the orange trees in
                      terracotta pots and the camera framing exactly the same.
                    image_urls:
                      - >-
                        https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/03/input-01.png
                    size: '3:4'
              callback:
                summary: Receive a completion callback
                value:
                  model: blackforestlabs/flux-kontext-pro
                  input:
                    prompt: >-
                      Replace the painted name on the bow "MARISOL" with
                      "ALBATROS". Paint the new letters in the same hand-painted
                      white capital lettering style, same size, same brush
                      texture, with the same chipping and weathering as the rest
                      of the hull. Keep everything else unchanged: the boat, its
                      sky blue hull and white stripe, the rope and buoy, the
                      pebble beach, the palafito stilt houses, the hills, the
                      overcast light and the camera framing.
                    image_urls:
                      - >-
                        https://cdn.vidgo.ai/apis/models/blackforestlabs/flux-kontext-pro/v1/02/input-01.png
                    size: '16:9'
                    output_format: jpg
                  callback_url: https://your-domain.com/callback
      responses:
        '200':
          description: Task submitted
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - data
                properties:
                  code:
                    type: integer
                    enum:
                      - 200
                  data:
                    type: object
                    required:
                      - task_id
                      - status
                      - created_time
                    properties:
                      task_id:
                        type: string
                      status:
                        type: string
                        enum:
                          - not_started
                          - running
                          - finished
                          - failed
                      created_time:
                        type: string
                        format: date-time
              example:
                code: 200
                data:
                  task_id: KH8OWRITIOASWYGA
                  status: running
                  created_time: '2026-09-26T11:02:37'
        '400':
          description: Request validation or account balance error
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '401':
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '404':
          description: Unknown or disabled model
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '408':
          description: Request timed out
          content:
            text/plain:
              schema:
                type: string
              example: Request timeout
        '422':
          description: Invalid JSON or non-object request body
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '429':
          description: Rate or API key credit limit exceeded
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '502':
          description: Task creation error
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '503':
          description: Model service temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Use VIDGO_API_KEY.

````