API reference · Meta

meta/sam-3-1/image-rle

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDmeta/sam-3-1/image-rle

Input Schema

10 parameters · 2 required · 8 optional

Parameter	Type	Required	Description
`image`	string	Required	URL of the image to be segmented
`prompt`	string	Required	Text prompt for segmentation · Default: "wheel"
`max_masks`	integer	Optional	Maximum number of masks to return when `return_multiple_masks` is enabled. · Min: 1 · Max: 32 · Default: 3
`apply_mask`	boolean	Optional	Apply the mask on the image. · Default: true
`box_prompts`	object[]	Optional	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: []
`include_boxes`	boolean	Optional	Whether to include bounding boxes for each mask (when available). · Default: false
`output_format`	string	Optional	The format of the generated image. · Options: jpeg, png · Default: "png" jpegpng
`point_prompts`	object[]	Optional	List of point prompts · Default: []
`include_scores`	boolean	Optional	Whether to include mask confidence scores. · Default: false
`return_multiple_masks`	boolean	Optional	If True, upload and return multiple generated masks as defined by `max_masks`. · Default: false

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "meta/sam-3-1/image-rle",
    "image": "https://raw.githubusercontent.com/facebookresearch/segment-anything-2/main/notebooks/images/truck.jpg",
    "prompt": "wheel",
    "max_masks": 3,
    "apply_mask": true,
    "box_prompts": [],
    "include_boxes": false,
    "output_format": "png",
    "point_prompts": [],
    "include_scores": false,
    "return_multiple_masks": false
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to Sam 3 1