Appearance

FLUX.1 [dev] with Controlnets and Loras

POST/v1/run

Flux General Rf Inversion 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-general/rf-inversion.

Default: bfl/flux-general/rf-inversion

stringpromptrequired

The prompt to edit the image with

stringimagerequired

URL of image to be edited

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: png

Optional<string>sigma_schedule

Sigmas schedule for the denoising process.

Optional<array<object>>control_loras

The LoRAs to use for the image generation which use a control image. You can use any number of LoRAs and they will be merged together to generate the final image.

Default:

Optional<boolean>use_beta_schedule

Specifies whether beta sigmas ought to be used.

Default: false

Optional<string>reference_image_url

URL of Image for Reference-Only

Optional<integer>reverse_guidance_end

Timestep to stop guidance during reverse process.

Default: 8

Optional<number>nag_scale

The scale for NAG. Higher values will result in a image that is more distant to the negative prompt.

Range: −∞ to 10

Default: 3

Optional<number>controller_guidance_forward

The controller guidance (gamma) used in the creation of structured noise.

Range: 0.01 to 3

Default: 0.6

Optional<number>nag_end

The proportion of steps to apply NAG. After the specified proportion of steps has been iterated, the remaining steps will use original attention processors in FLUX.

Range: −∞ to 1

Default: 0.25

Optional<number>reference_strength

Strength of reference_only generation. Only used if a reference image is provided.

Range: -3 to 3

Default: 0.65

Optional<number>nag_tau

The tau for NAG. Controls the normalization of the hidden state. Higher values will result in a less aggressive normalization, but may also lead to unexpected changes with respect to the original image. Not recommended to change this value.

Default: 2.5

Optional<number>reference_start

The percentage of the total timesteps when the reference guidance is to bestarted.

Range: 0 to 1

Default: 0

Optional<integer>reverse_guidance_start

Timestep to start guidance during reverse process.

Default: 0

Optional<number>reference_end

The percentage of the total timesteps when the reference guidance is to be ended.

Range: 0 to 1

Default: 1

Optional<number>max_shift

Max shift for the scheduled timesteps

Range: 0.01 to 5

Default: 1.15

Optional<string>reverse_guidance_schedule

Scheduler for applying reverse guidance.

Allowed values: constant, linear_increase, linear_decrease

Default: constant

Optional<number>base_shift

Base shift for the scheduled timesteps

Range: 0.01 to 5

Default: 0.5

Optional<number>nag_alpha

The alpha value for NAG. This value is used as a final weighting factor for steering the normalized guidance (positive and negative prompts) in the direction of the positive prompt. Higher values will result in less steering on the normalized guidance where lower values will result in considering the positive prompt guidance more.

Range: −∞ to 1

Default: 0.25

Optional<string>fill_image

Use an image input to influence the generation. Can be used to fill images in masked areas.

Optional<array<object>>easycontrols

EasyControl Inputs to use for image generation.

Default:

Optional<number>controller_guidance_reverse

The controller guidance (eta) used in the denoising process.Using values closer to 1 will result in an image closer to input.

Range: 0.01 to 3

Default: 0.75

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 same seed and the same prompt given to the same version of the model will output the same image every time.

Optional<integer>num_inference_steps

Number of denoising or inference steps to run when supported.

Range: 1 to 50

Default: 28

Optional<number>guidance_scale

Request parameter supported by this model.

Range: 0 to 20

Default: 3.5

Optional<array>loras

Request parameter supported by this model.

Default:

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

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

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