Start building
SandBase

Appearance

Flux 2 Dev Edit

POST/v1/run

Flux 2 Dev Edit is BFL's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to bfl/flux-2/dev/edit.

Default: bfl/flux-2/dev/edit

stringpromptrequired

The prompt to edit the image.

Optional<array<string>>images

The URLs of the images for editing. A maximum of 4 images are allowed, if more are provided, only the first 4 will be used.

Optional<number>guidance_scale

Guidance Scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you.

Range: 0 to 20

Default: 2.5

Optional<integer>num_inference_steps

The number of inference steps to perform.

Range: 4 to 50

Default: 28

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: png

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16

Optional<integer>seed

The seed to use for the generation. If not provided, a random seed will be used.

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async