Run models all in one Sandbox 🏖️
Docs
Log-inSign-up

fal-ai/physic-edit

Physics-aware image editing with PhysicEdit. Make realistic edits that follow real-world physics—handles complex effects like refraction, material changes, and deformation with physically plausible results.
Inference
Commercial use
Schema
LLMs
PlaygroundAPI

Table of contents

About

Edit

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/physic-edit", {
  input: {
    image_url: "https://v3b.fal.media/files/b/0a91d47e/NG382xuDf06EcPCaS2eW3_Signature_Ice_Sculptures-03.jpg",
    prompt: "Make the ice sculpture melt gradually, with water pooling beneath and light refracting through the translucent surface"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/physic-edit", {
  input: {
    image_url: "https://v3b.fal.media/files/b/0a91d47e/NG382xuDf06EcPCaS2eW3_Signature_Ice_Sculptures-03.jpg",
    prompt: "Make the ice sculpture melt gradually, with water pooling beneath and light refracting through the translucent surface"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/physic-edit", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/physic-edit", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

image_url string* required

URL of the image to edit with physics-aware transformations.

prompt string* required

The editing instruction describing the physical transformation to apply.

negative_prompt string

Description of unwanted elements in the output. Default value: ""

seed integer

Random seed for reproducibility. Same seed and prompt produce identical output.

num_inference_steps integer

Number of denoising steps. More steps generally produce higher quality but take longer. Default value: 40

guidance_scale float

Classifier-free guidance scale. Higher values follow the prompt more closely. Default value: 4

sync_mode boolean

If True, the image will be returned as a data URI.

enable_safety_checker boolean

Enable content safety checking on the output. Default value: true

output_format OutputFormatEnum

The format of the generated image. Default value: "jpeg"

Possible enum values: jpeg, png

{
  "image_url": "https://v3b.fal.media/files/b/0a91d47e/NG382xuDf06EcPCaS2eW3_Signature_Ice_Sculptures-03.jpg",
  "prompt": "Make the ice sculpture melt gradually, with water pooling beneath and light refracting through the translucent surface",
  "num_inference_steps": 40,
  "guidance_scale": 4,
  "enable_safety_checker": true,
  "output_format": "jpeg"
}

Output#

images list<Image>* required

The edited images.

timings Timings* required
seed integer* required

Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.

has_nsfw_concepts list<boolean>* required

Whether the generated images contain NSFW concepts.

prompt string* required

The prompt used for generating the image.

{
  "images": [
    {
      "height": 1152,
      "content_type": "image/jpeg",
      "url": "https://v3b.fal.media/files/b/0a91cf62/DdpKY15kkD6N6v66uJ0q1.jpg",
      "width": 864
    }
  ],
  "prompt": ""
}

Other types#

Image#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.