> ## 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.

# GPT Image 2.5 Flare Image Edit

> Edit one image with GPT Image 2.5 Flare using text instructions and reference images.

<Tip>
  1. Submit the request with `VIDGO_API_KEY`. A `task_id` is returned. 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>

# GPT Image 2.5 Flare Image Edit

## Usage Guide

Edit one image with GPT Image 2.5 Flare using text instructions and reference images.

* Set `model` to `openai/gpt-image-2.5-flare/edit`.
* Place `model` and optional `callback_url` at the request root; place workflow parameters inside `input`.
* Each request produces one image.
* For prompt-only generation, use [Text to Image](/api-manual/image-series/gpt-image-2-5-flare-text-to-image) with `model=openai/gpt-image-2.5-flare/text-to-image`.

## Parameter Details

* `prompt` is required. Supply non-blank text of up to 32,000 characters.
* `image_urls` is required and accepts 1 to 16 reference image URLs. Use publicly accessible HTTP(S) URLs in the same order as the references in your prompt.
* `size` defaults to `1:1`. `auto` is available only with `resolution=1K`.
* Custom `WIDTHxHEIGHT` dimensions require `2K` or `4K`. Both edges must be positive multiples of 16, the longest edge must not exceed 3,840 pixels, the aspect ratio must not exceed 3:1, and total pixels must be between 655,360 and 8,294,400. A 3,840-pixel edge requires `4K`.
* `mask_url` selects the area to edit and requires the reference images in `image_urls`.
* A transparent background requires `output_format=png` or `webp`.

## Developer Notes

* Submission is asynchronous. Use the task status endpoint or a completion webhook to retrieve the final image.
* Billing is per output image and depends on `quality` and the requested `resolution` tier. Aspect-ratio requests keep the selected tier; actual image dimensions may vary.
* Credits are deducted on submission and refunded if the task fails.

## Optional parameters

* `size` (string): Use `auto`, `1:1`, `2:3`, `3:2`, `4:3`, `3:4`, `4:5`, `5:4`, `16:9`, `9:16`, `21:9`, or custom `WIDTHxHEIGHT` dimensions. Default: `1:1`.
* `resolution` (string): Output resolution tier. Accepted values: `1K`, `2K`, `4K`. Default: `1K`.
* `output_format` (string): Output image format. Transparent output requires PNG or WebP. Accepted values: `png`, `jpeg`, `webp`. Default: `png`.
* `quality` (string): Image quality tier. Billing depends on quality and the requested resolution tier. Accepted values: `low`, `medium`, `high`, `xhigh`, `max`. Default: `high`.
* `background` (string): Background mode. Transparent output requires PNG or WebP. Accepted values: `auto`, `transparent`, `opaque`. Default: `auto`.
* `mask_url` (string): Optional mask selecting the area to edit. Requires at least one reference image.


## OpenAPI

````yaml api-manual/image-series/gpt-image-2-5-flare-edit.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - GPT Image 2.5 Flare Image Edit
  description: >-
    Edit one image with GPT Image 2.5 Flare using text instructions and
    reference images.
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - GPT Image 2.5 Flare Image Edit
      summary: Submit GPT Image 2.5 Flare Image Edit Task
      operationId: submitGPTImage25FlareImageEditTask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              reference-edit:
                summary: Edit with reference images
                value:
                  model: openai/gpt-image-2.5-flare/edit
                  input:
                    prompt: >-
                      Preserve the product and replace the background with a
                      warm modern studio.
                    image_urls:
                      - https://cdn.vidgo.ai/temp/reference-product.png
                    size: '1:1'
                    resolution: 2K
              mask-edit:
                summary: Edit a masked region
                value:
                  model: openai/gpt-image-2.5-flare/edit
                  input:
                    prompt: Replace the masked area with a small vase of flowers.
                    image_urls:
                      - https://cdn.vidgo.ai/temp/reference-product.png
                    mask_url: https://cdn.vidgo.ai/temp/edit-mask.png
                    size: auto
              transparent-background:
                summary: Edit an image with a transparent background
                value:
                  model: openai/gpt-image-2.5-flare/edit
                  input:
                    prompt: Keep the silver robot and remove its background.
                    background: transparent
                    output_format: webp
                    resolution: 4K
                    quality: xhigh
                    image_urls:
                      - https://cdn.vidgo.ai/temp/reference-product.png
              custom-size:
                summary: Edit with custom dimensions
                value:
                  model: openai/gpt-image-2.5-flare/edit
                  input:
                    prompt: >-
                      Preserve the product and place it in a panoramic city
                      garden.
                    size: 2304x1536
                    resolution: 2K
                    quality: medium
                    image_urls:
                      - https://cdn.vidgo.ai/temp/reference-product.png
      responses:
        '200':
          description: >-
            Task submission result. A task ID identifies asynchronous work;
            generation may still be running.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      additionalProperties: false
      properties:
        model:
          type: string
          example: openai/gpt-image-2.5-flare/edit
        callback_url:
          type: string
          format: uri
          description: Optional webhook URL for completion or failure notifications.
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
            - image_urls
          additionalProperties: false
          properties:
            prompt:
              type: string
              minLength: 1
              maxLength: 32000
              pattern: \S
              description: |-
                Text instructions describing the edit.

                Include at least one non-whitespace character.
            size:
              type: string
              description: >-
                Output aspect ratio or WIDTHxHEIGHT.


                Defaults to 1:1.


                auto requires 1K.


                Custom dimensions require 2K or 4K, multiples of 16, maximum
                edge 3840, aspect ratio at most 3:1, and 655360–8294400 pixels.


                A 3840-pixel edge requires 4K.
              pattern: >-
                ^(?:auto|1:1|2:3|3:2|4:3|3:4|4:5|5:4|16:9|9:16|21:9|\s*\d+\s*[xX]\s*\d+\s*)$
              default: '1:1'
            resolution:
              type: string
              enum:
                - 1K
                - 2K
                - 4K
              default: 1K
              description: Output resolution tier.
            image_urls:
              type: array
              maxItems: 16
              items:
                type: string
                format: uri
                pattern: ^https?://
              description: Required reference images for editing, in prompt order.
              minItems: 1
            output_format:
              type: string
              enum:
                - png
                - jpeg
                - webp
              default: png
              description: |-
                Output image format.

                Transparent output requires PNG or WebP.
            quality:
              type: string
              enum:
                - low
                - medium
                - high
                - xhigh
                - max
              default: high
              description: |-
                Image quality tier.

                Billing depends on quality and the requested resolution tier.
            background:
              type: string
              enum:
                - auto
                - transparent
                - opaque
              default: auto
              description: |-
                Background mode.

                Transparent output requires PNG or WebP.
            mask_url:
              type: string
              format: uri
              pattern: ^https?://
              description: |-
                Optional mask selecting the area to edit.

                Requires at least one reference image.
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-example-001
            status:
              type: string
              example: running
            created_time:
              type: string
              format: date-time
              example: '2026-10-09T10:30:00'
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
        error:
          type: object
          properties:
            message:
              type: string
              example: Invalid request parameters
            type:
              type: string
              example: invalid_request_error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Use `Authorization: Bearer VIDGO_API_KEY`.'

````

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