Segment Anything Model

fal-ai/imageutils/sam
Inference
Commercial use

1. Calling the API#

Install the client#

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

npm install --save @fal-ai/serverless-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 * as fal from "@fal-ai/serverless-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);
    }
  },
});

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 * as fal from "@fal-ai/serverless-client";

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

3. 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 * as fal from "@fal-ai/serverless-client";

// Upload a file (you can get a file reference from an input element or a drag-and-drop event)
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

// Use the URL in your request
const result = await fal.subscribe("fal-ai/imageutils/sam", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

image_url*string

Url to input image

text_promptstring

The prompt to use when generating masks

sizeinteger

Image size Default value: 1024

ioufloat

IOU threshold for filtering the annotations Default value: 0.9

retinaboolean

Draw high-resolution segmentation masks Default value: true

confidencefloat

Object confidence threshold Default value: 0.4

box_promptlist<list<void>>

Coordinates for multiple boxes, e.g. [[x,y,w,h],[x2,y2,w2,h2]] Default value: 0,0,0,0

point_promptlist<list<void>>

Coordinates for multiple points [[x1,y1],[x2,y2]] Default value: 0,0

point_labellist<integer>

Label for point, [1,0], 0 = background, 1 = foreground Default value: 0

with_contoursboolean

Draw the edges of the masks

better_qualityboolean

Attempt better quality output using morphologyEx

black_whiteboolean

Output black and white, multiple masks will be combined into one mask

invertboolean

Invert 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
  ]
}

Output#

imageImage

Combined image of all detected masks

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  }
}