Start building
SandBase

Appearance

Sam 3

POST/v1/run

Sam 3 Video Rle is Meta's video-to-video AI model. Transform, enhance, and edit video content using text prompts - from style changes to object manipulation and scene modification.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to meta/sam-3/video-rle.

Default: meta/sam-3/video-rle

stringpromptrequired

Text prompt for segmentation. Use commas to track multiple objects (e.g., 'person, cloth').

Default:

Optional<string>mask

The URL of the mask to be applied initially.

Optional<string>video

The URL of the video to be segmented.

Optional<boolean>apply_mask

Apply the mask on the video.

Default: false

Optional<boolean>boundingbox_zip

Return per-frame bounding box overlays as a zip archive.

Default: false

Optional<array<object>>box_prompts

List of box prompts with optional frame_index.

Default:

Optional<array<object>>point_prompts

List of point prompts with frame indices.

Default:

Optional<number>detection_threshold

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.

Range: 0.01 to 1

Default: 0.5

Optional<integer>frame_index

Frame index used for initial interaction when mask_url is provided.

Default: 0

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async