Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the result through the unified Query Task Status endpoint.
FLUX 3 Klein Edit changes or combines existing images from a plain-language instruction. Send one image to restyle, retouch or replace elements, or up to ten to compose a product into a new scene or merge several references into one picture, with output at 1K, 2K or 4K. FLUX 3 Klein is the compact member of Black Forest Labs’ FLUX 3 image family, built for fast generation and instruction-based editing. Vidgo exposes it as two model IDs: Text to Image and Edit.

Models

  • blackforestlabs/flux-3-klein/edit — Image edit with FLUX 3 Klein, 1–10 input images, 1–4 results.

Features

  • Image edit from a natural-language instruction.
  • Multi-image composition with up to 10 inputs, referenced by order in the prompt.
  • Three resolution tiers: 1K, 2K, 4K; presets or a custom size.
  • PNG, JPEG or WebP output, 1–4 images per request.

Required parameters

  • prompt (string): The edit instruction. Refer to inputs by position, for example “the first image” and “the second image”. Must not be blank.
  • image_urls (string[]): 1–10 images. Public HTTP(S) URLs, or base64 data URIs that Vidgo uploads first.

Optional parameters

  • n (integer): Number of images, 1–4. Default 1.
  • resolution (string): 1K, 2K or 4K. Default 1K. See Resolution.
  • size (string): Preset or custom WIDTHxHEIGHT. Default 1:1. See Resolution.
  • output_format (string): png, jpeg or webp. Default png.
  • enable_safety_checker (boolean): Upstream safety checker. Default true.

Resolution

  • With a preset size (1:1, 4:3, 3:4, 16:9, 9:16, 3:2, 2:3), the image is scaled so its long edge matches the tier: 1K → 1024 px, 2K → 2048 px, 4K → 4096 px.
  • With a custom size such as 1920x1080, each side must be 256–4096 and a multiple of 16, and you must send resolution matching the long edge: up to 1024 → 1K, up to 2048 → 2K, above 2048 → 4K. A mismatch returns 400.

Output

The finished task returns one file per requested image (n) in the files array of Query Task Status and the callback payload.

Examples

  • Edit one image: turn a daytime street into a rainy night scene, 16:9, 1K.
  • Combine two images at 2K with callback: put the product from the first image into the scene from the second, n: 2, WebP, with a callback_url.

Notes

  • Results with many references can vary in pose and viewpoint consistency; describe the subject clearly and keep the number of inputs as low as the task allows.
  • An empty image_urls array or more than ten images returns 400. Fields not listed above return 400. model and callback_url belong at the request root, not inside input.
  • Credits are reserved at submission and depend on resolution and n. Text-to-image and edit use the same rates. A failed task is refunded in full. See the pricing page for current rates. The number of input images does not change the price.

Authorizations

Authorization
string
header
required

All API endpoints require Bearer Token authentication

Get your API Key:

Go to Dashboard → API Key (API Key Management Page) to get your API Key

Add it to the request header:

Body

application/json
model
string
required

Model ID. Use blackforestlabs/flux-3-klein/edit.

Example:

"blackforestlabs/flux-3-klein/edit"

input
object
required

Generation parameters.

callback_url
string<uri> | null

Optional public HTTP(S) endpoint that receives a POST when the task becomes finished or failed. HTTPS is recommended. Omit it, or send null or an empty string, to disable callbacks.

Example:

"https://your-domain.com/callback"

Response

Task submitted

code
enum<integer>
required

HTTP status code.

Available options:
200
data
object
required