GET

/v1/schemas/fal/image/fal-ai/sam-3/image-rle

Accept:

kind inputactivity imagehash 9827da8f…extracted Jul 28, 2026version currentsource upstream spec ↗

field	recorded source
schema	Source linked above. Source trace `a627e165b99d04bce894d273b89baf6c070fb6c0662e8af9447e69e3d7941da4` { "fetchedAt": 1785214897, "extractorVersion": "1", "verifiedAt": null }

Request body

12 properties · 1 required · 2 $defs

property	type	description	constraints
image_url*	string	URL of the image to be segmented
return_multiple_masks	boolean	If True, upload and return multiple generated masks as defined by `max_masks`.	default: false
output_format	enum	The format of the generated image.	jpeg \| png \| webp · default: "png"
include_scores	boolean	Whether to include mask confidence scores.	default: false
apply_mask	boolean	Apply the mask on the image.	default: true
point_prompts	PointPrompt[]	List of point prompts	default: []
include_boxes	boolean	Whether to include bounding boxes for each mask (when available).	default: false
prompt	string	Text prompt for segmentation	default: "wheel"
sync_mode	boolean	If True, the media will be returned as a data URI.	default: false
text_prompt	string	[DEPRECATED] Use 'prompt' instead. Kept for backward compatibility.	nullable · deprecated
box_prompts	BoxPrompt[]	Box prompt coordinates (x_min, y_min, x_max, y_max). Multiple boxes supported - use object_id to group boxes for the same object or leave empty for separate objects.	default: []
max_masks	integer	Maximum number of masks to return when `return_multiple_masks` is enabled.	1 ≤ n ≤ 32 · default: 3

Types

2 $defs

BoxPromptobject

object_id	integer	Optional object identifier. Boxes sharing an object id refine the same object.	nullable
y_max	integer	Y Max Coordinate of the box	nullable
frame_index	integer	The frame index to interact with.	nullable
y_min	integer	Y Min Coordinate of the box	nullable
x_min	integer	X Min Coordinate of the box	nullable
x_max	integer	X Max Coordinate of the box	nullable

PointPromptobject

y	integer	Y Coordinate of the prompt	nullable
object_id	integer	Optional object identifier. Prompts sharing an object id refine the same object. When a text prompt is also given, the id selects which detected object the points refine.	nullable
frame_index	integer	The frame index to interact with.	nullable
label	enum	1 for foreground, 0 for background	0 \| 1 · nullable
x	integer	X Coordinate of the prompt	nullable

Validate a payload

before you spend tokens

shell

$ curl -X POST https://modelschemas.com/v1/validate \
    -d '{"provider":"fal","endpointId":"fal-ai/sam-3/image-rle","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}