Loading API documentation
This model is no longer supported.
This model is no longer supported.
Sam
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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/imageutils/sam", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/remove_background/elephant.jpg"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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/imageutils/sam", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/remove_background/elephant.jpg"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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/imageutils/sam", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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/imageutils/sam", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
image_url string* requiredUrl to input image
text_prompt stringThe prompt to use when generating masks
size integerImage size Default value: 1024
iou floatIOU threshold for filtering the annotations Default value: 0.9
retina booleanDraw high-resolution segmentation masks Default value: true
confidence floatObject confidence threshold Default value: 0.4
Coordinates for multiple boxes, e.g. [[x,y,w,h],[x2,y2,w2,h2]]
Coordinates for multiple points [[x1,y1],[x2,y2]]
Label for point, [1,0], 0 = background, 1 = foreground
with_contours booleanDraw the edges of the masks
better_quality booleanAttempt better quality output using morphologyEx
black_white booleanOutput black and white, multiple masks will be combined into one mask
invert booleanInvert mask colors
{
"image_url": "https://storage.googleapis.com/falserverless/model_tests/remove_background/elephant.jpg",
"text_prompt": "a photo of elephant",
"size": 1024,
"iou": 0.9,
"retina": true,
"confidence": 0.4,
"box_prompt": [
[
0,
0,
0,
0
]
],
"point_prompt": [
[
0,
0
]
],
"point_label": [
0
]
}Combined image of all detected masks
{}url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
width integerThe width of the image in pixels.
height integerThe height of the image in pixels.