Sam 3 | Image to Image

fal-ai/sam-3/image-rle

SAM 3 is a unified foundation model for promptable segmentation in images and videos. It can detect, segment, and track objects using text or visual prompts such as points, boxes, and masks.

Inference

Commercial use

Schema

LLMs

Playground API

About

Segment Image Rle

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

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/sam-3/image-rle", {
  input: {
    image_url: "https://raw.githubusercontent.com/facebookresearch/segment-anything-2/main/notebooks/images/truck.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);

Real-time via WebSockets#

This model has a real-time mode via websockets, this is supported via the fal.realtime client.

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

const connection = fal.realtime.connect("fal-ai/sam-3/image-rle", {
  onResult: (result) => {
    console.log(result);
  },
  onError: (error) => {
    console.error(error);
  }
});

connection.send({
  image_url: "https://raw.githubusercontent.com/facebookresearch/segment-anything-2/main/notebooks/images/truck.jpg"
});

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"
});

Protect your API 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.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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/sam-3/image-rle", {
  input: {
    image_url: "https://raw.githubusercontent.com/facebookresearch/segment-anything-2/main/notebooks/images/truck.jpg"
  },
  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/sam-3/image-rle", {
  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/sam-3/image-rle", {
  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);

Auto uploads

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.

5. Schema#

Input#

image_url string* required

URL of the image to be segmented

text_prompt string

Text prompt for segmentation Default value: ""

prompts list<PointPrompt>

List of point prompts

box_prompts list<BoxPrompt>

Coordinates for boxes

apply_mask boolean

Apply the mask on the image. Default value: true

sync_mode boolean

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

output_format OutputFormatEnum

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

Possible enum values: jpeg, png, webp

return_multiple_masks boolean

If True, upload and return multiple generated masks as defined by max_masks.

max_masks integer

Maximum number of masks to return when return_multiple_masks is enabled. Default value: 3

include_scores boolean

Whether to include mask confidence scores.

include_boxes boolean

Whether to include bounding boxes for each mask (when available).

{
  "image_url": "https://raw.githubusercontent.com/facebookresearch/segment-anything-2/main/notebooks/images/truck.jpg",
  "prompts": [
    {
      "y": 375,
      "label": 1,
      "x": 500
    }
  ],
  "box_prompts": [
    {
      "y_min": 600,
      "x_max": 700,
      "x_min": 425,
      "y_max": 875
    }
  ],
  "apply_mask": true,
  "output_format": "png",
  "max_masks": 3
}

Output#

rle string | list<string>* required

Run Length Encoding of the mask.

boundingbox_frames_zip File

Zip file containing per-frame bounding box overlays.

metadata list<MaskMetadata>

Per-mask metadata when multiple RLEs are returned.

scores list<float>

Per-mask confidence scores when requested.

boxes list<list<float>>

Per-mask normalized bounding boxes [cx, cy, w, h] when requested.

{
  "metadata": [
    {}
  ]
}

Other types#

BoxPrompt#

x_min integer

X Min Coordinate of the box

y_min integer

Y Min Coordinate of the box

x_max integer

X Max Coordinate of the box

y_max integer

Y Max Coordinate of the box

object_id integer

Optional object identifier. Boxes sharing an object id refine the same object.

frame_index integer

The frame index to interact with.

PointPrompt#

x integer

X Coordinate of the prompt Default value: 305

y integer

Y Coordinate of the prompt Default value: 350

label LabelEnum

1 for foreground, 0 for background Default value: "1"

Possible enum values: 0, 1

object_id integer

Optional object identifier. Prompts sharing an object id refine the same object.

frame_index integer

The frame index to interact with.

PointPromptBase#

x integer

X Coordinate of the prompt Default value: 305

y integer

Y Coordinate of the prompt Default value: 350

label LabelEnum

1 for foreground, 0 for background Default value: "1"

Possible enum values: 0, 1

object_id integer

Optional object identifier. Prompts sharing an object id refine the same object.

File#

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.

file_data string

File data

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.

file_data string

File data

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

BoxPromptBase#

x_min integer

X Min Coordinate of the box

y_min integer

Y Min Coordinate of the box

x_max integer

X Max Coordinate of the box

y_max integer

Y Max Coordinate of the box

object_id integer

Optional object identifier. Boxes sharing an object id refine the same object.

MaskMetadata#

index integer* required

Index of the mask inside the model output.

score float

Score for this mask.

box list<float>

Bounding box for the mask in normalized cxcywh coordinates.

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

Real-time via WebSockets#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

BoxPrompt#

PointPrompt#

PointPromptBase#

File#

Image#

BoxPromptBase#

MaskMetadata#

Related Models

Sam 3 Image to Image

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

Real-time via WebSockets#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

BoxPrompt#

PointPrompt#

PointPromptBase#

File#

Image#

BoxPromptBase#

MaskMetadata#

Related Models