GET
/v1/schemas/fal/video/fal-ai/sam-3/video-rle
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above.Source trace8fd56c5844c0e47d5f1e02a96bd82bdebebc8548c82819d1e5f94b621134c435{
"fetchedAt": 1785214897,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
9 properties · 1 required · 2 $defs| property | type | description | constraints |
|---|---|---|---|
| video_url* | string | The URL of the video to be segmented. | |
| apply_mask | boolean | Apply the mask on the video. | default: false |
| frame_index | integer | Frame index used for initial interaction when mask_url is provided. | default: 0 |
| boundingbox_zip | boolean | Return per-frame bounding box overlays as a zip archive. | default: false |
| point_prompts | PointPrompt[] | List of point prompts with frame indices. | default: [] |
| detection_threshold | number | Detection confidence threshold (0.0-1.0). Lower = more detections but less precise. Defaults: 0.5 for existing, 0.7 for new objects. Try 0.2-0.3 if text prompts fail. | 0.01 ≤ n ≤ 1 · default: 0.5 |
| prompt | string | Text prompt for segmentation. Use commas to track multiple objects (e.g., 'person, cloth'). | default: "" |
| mask_url | string | The URL of the mask to be applied initially. | nullable |
| box_prompts | BoxPrompt[] | List of box prompts with optional frame_index. | default: [] |
Types
2 $defsBoxPromptobject
| 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 tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"fal","endpointId":"fal-ai/sam-3/video-rle","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}