GET
/v1/schemas/fal/image/fal-ai%2Fflux-general%2Frf-inversion
Accept:
Request body
36 properties · 2 required · 8 $defs| property | type | description | constraints |
|---|---|---|---|
| image_url* | string | URL of image to be edited | |
| prompt* | string | The prompt to edit the image with | |
| reference_image_url | string | URL of Image for Reference-Only | |
| enable_safety_checker | boolean | If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images. | default: true |
| nag_tau | number | 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. | n > 0 · default: 2.5 |
| reference_end | number | The percentage of the total timesteps when the reference guidance is to be ended. | 0 ≤ n ≤ 1 · default: 1 |
| controller_guidance_reverse | number | The controller guidance (eta) used in the denoising process.Using values closer to 1 will result in an image closer to input. | 0.01 ≤ n ≤ 3 · default: 0.75 |
| max_shift | number | Max shift for the scheduled timesteps | 0.01 ≤ n ≤ 5 · default: 1.15 |
| nag_end | number | 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. | 0 < n ≤ 1 · default: 0.25 |
| controlnet_unions | ControlNetUnion[] | The controlnet unions to use for the image generation. Only one controlnet is supported at the moment. | default: [] |
| nag_alpha | number | 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 lo… | 0 < n ≤ 1 · default: 0.25 |
| controller_guidance_forward | number | The controller guidance (gamma) used in the creation of structured noise. | 0.01 ≤ n ≤ 3 · default: 0.6 |
| image_size | ImageSize | enum | The size of the generated image. | |
| negative_prompt | string | Negative prompt to steer the image generation away from unwanted features. By default, we will be using NAG for processing the negative prompt. | default: "" |
| num_images | integer | The number of images to generate. This is always set to 1 for streaming output. | 1 ≤ n ≤ 10 · default: 1 |
| control_loras | ControlLoraWeight[] | 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: [] |
| use_beta_schedule | boolean | Specifies whether beta sigmas ought to be used. | default: false |
| reverse_guidance_schedule | enum | Scheduler for applying reverse guidance. | constant | linear_increase | linear_decrease · default: "constant" |
| reverse_guidance_start | integer | Timestep to start guidance during reverse process. | default: 0 |
| sigma_schedule | const | Sigmas schedule for the denoising process. | "sgm_uniform" · nullable |
| output_format | enum | The format of the generated image. | jpeg | png · default: "png" |
| use_cfg_zero | boolean | Uses CFG-zero init sampling as in https://arxiv.org/abs/2503.18886. | default: false |
| sync_mode | boolean | If `True`, the media will be returned as a data URI and the output data won't be available in the request history. | default: false |
| reverse_guidance_end | integer | Timestep to stop guidance during reverse process. | default: 8 |
| fill_image | ImageFillInput | Use an image input to influence the generation. Can be used to fill images in masked areas. | nullable |
| controlnets | ControlNet[] | The controlnets to use for the image generation. Only one controlnet is supported at the moment. | default: [] |
| num_inference_steps | integer | The number of inference steps to perform. | 1 ≤ n ≤ 50 · default: 28 |
| reference_strength | number | Strength of reference_only generation. Only used if a reference image is provided. | -3 ≤ n ≤ 3 · default: 0.65 |
| base_shift | number | Base shift for the scheduled timesteps | 0.01 ≤ n ≤ 5 · default: 0.5 |
| nag_scale | number | The scale for NAG. Higher values will result in a image that is more distant to the negative prompt. | 1 < n ≤ 10 · default: 3 |
| seed | integer | The same seed and the same prompt given to the same version of the model will output the same image every time. | nullable |
| guidance_scale | number | The CFG (Classifier Free 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. | 0 ≤ n ≤ 20 · default: 3.5 |
| scheduler | enum | Scheduler for the denoising process. | euler | dpmpp_2m · default: "euler" |
| easycontrols | EasyControlWeight[] | EasyControl Inputs to use for image generation. | default: [] |
| reference_start | number | The percentage of the total timesteps when the reference guidance is to bestarted. | 0 ≤ n ≤ 1 · default: 0 |
| loras | LoraWeight[] | The LoRAs to use for the image generation. You can use any number of LoRAs and they will be merged together to generate the final image. | default: [] |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"fal","endpointId":"fal-ai/flux-general/rf-inversion","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}