> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SAM 3

> SAM 3 is a unified foundation model for promptable segmentation in images and videos.

<Info>
  Pricing: **\$0.005/image**. Endpoint: `POST /v1/models/meta/sam-3/image/runs`.
</Info>

SAM 3 is a unified foundation model for promptable segmentation in images and videos.

## Overview

* **Endpoint**: [https://api.runflow.io/v1/models/meta/sam-3/image/runs](https://api.runflow.io/v1/models/meta/sam-3/image/runs)
* **Model ID**: meta/sam-3/image
* **Provider**: Meta
* **License**: commercial
* **Last Updated**: 2026-04-05

## Pricing

* **Base price**: \$0.005/image
* **Note**: Usage-based, per image

# SAM 3 API

**Endpoint:** `POST /v1/models/meta/sam-3/image/runs`

## Run the model

### Python

```python theme={"dark"}
import requests

response = requests.post(
    "https://api.runflow.io/v1/models/meta/sam-3/image/runs",
    headers={"Authorization": "Bearer RUNFLOW_API_KEY"},
    json={
        "input": {
            "prompt": "keyboard",
            "image_url": "https://v3b.fal.media/files/b/0a92a995/fV5oYdcCV3NAmgWJISpIP_tmpdddcks4v.png",
            "apply_mask": False,
            "return_multiple_masks": True
        },
        "callback_url": "https://your-server.com/webhook"
    },
)

data = response.json()
print(data)
```

### Node.js

```javascript theme={"dark"}
const response = await fetch(
  "https://api.runflow.io/v1/models/meta/sam-3/image/runs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer RUNFLOW_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "input": {
            "prompt": "keyboard",
            "image_url": "https://v3b.fal.media/files/b/0a92a995/fV5oYdcCV3NAmgWJISpIP_tmpdddcks4v.png",
            "apply_mask": false,
            "return_multiple_masks": true
        },
        "callback_url": "https://your-server.com/webhook"
    }),
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash theme={"dark"}
curl -X POST https://api.runflow.io/v1/models/meta/sam-3/image/runs \
  -H "Authorization: Bearer $RUNFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
    "input": {
        "prompt": "keyboard",
        "image_url": "https://v3b.fal.media/files/b/0a92a995/fV5oYdcCV3NAmgWJISpIP_tmpdddcks4v.png",
        "apply_mask": false,
        "return_multiple_masks": true
    },
    "callback_url": "https://your-server.com/webhook"
}
JSON
```

## Request parameters

| Parameter      | Type           | Required | Description                                                 |
| -------------- | -------------- | -------- | ----------------------------------------------------------- |
| `input`        | object         | required | Model input parameters. See "Input schema" below.           |
| `callback_url` | string \| null | optional | Webhook URL - POSTed when the run reaches a terminal state. |
| `metadata`     | object \| null | optional | Arbitrary key-value pairs attached to the run.              |

## Input schema

| Field                   | Type    | Required | Allowed values        | Description                                                                                                                                                                |
| ----------------------- | ------- | -------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prompt`                | string  | optional | Any                   | Text prompt for segmentation                                                                                                                                               |
| `include_boxes`         | boolean | optional | Any                   | Whether to include bounding boxes for each mask (when available).                                                                                                          |
| `include_scores`        | boolean | optional | Any                   | Whether to include mask confidence scores.                                                                                                                                 |
| `return_multiple_masks` | boolean | optional | Any                   | If True, upload and return multiple generated masks as defined by `max_masks`.                                                                                             |
| `image_url`             | image   | required | Any                   | URL of the image to be segmented                                                                                                                                           |
| `sync_mode`             | boolean | optional | Any                   | If True, the media will be returned as a data URI.                                                                                                                         |
| `point_prompts`         | json    | optional | Any                   | List of point prompts                                                                                                                                                      |
| `output_format`         | string  | optional | `jpeg`, `png`, `webp` | The format of the generated image.                                                                                                                                         |
| `max_masks`             | integer | optional | Any                   | Maximum number of masks to return when `return_multiple_masks` is enabled.                                                                                                 |
| `box_prompts`           | json    | optional | Any                   | 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. |
| `apply_mask`            | boolean | optional | Any                   | Apply the mask on the image.                                                                                                                                               |
| `text_prompt`           | string  | optional | Any                   | \[DEPRECATED] Use 'prompt' instead. Kept for backward compatibility.                                                                                                       |

## Output schema

| Field           | Type | Description                                                                                         |
| --------------- | ---- | --------------------------------------------------------------------------------------------------- |
| `outputs`       | json | Unified output array - one entry per generated artifact with url/type/width/height/duration/etc.    |
| `model_data`    | json | Model-specific extra fields (prompt, description, actual\_prompt, masks, etc.) keyed by field name. |
| `nsfw_detected` | json | true if the provider flagged output as NSFW, false if cleared, null if not checked.                 |
| `seed`          | json | Deterministic seed used for generation, or null if the provider doesn't return one.                 |
| `timing`        | json | Provider timing info (inference\_ms etc.), or null.                                                 |

## Callback payload

When you provide a `callback_url`, Runflow POSTs to it once the run reaches a terminal state.

| Field          | Type           | Description                                                    |
| -------------- | -------------- | -------------------------------------------------------------- |
| `event`        | string         | Event type: "run.completed", "run.failed", or "run.cancelled". |
| `run_id`       | string         | The unique identifier of the run.                              |
| `status`       | string         | Terminal status: "succeeded", "failed", or "cancelled".        |
| `output`       | object \| null | The run output. Null if the run failed or was cancelled.       |
| `duration_ms`  | number \| null | Total run duration in milliseconds.                            |
| `created_at`   | string \| null | ISO 8601 timestamp when the run was created.                   |
| `completed_at` | string \| null | ISO 8601 timestamp when the run reached terminal state.        |
| `metadata`     | object \| null | The metadata object passed at run creation, if any.            |

* **Retries:** 3 attempts with exponential backoff (1s, 2s). Retries on 5xx / network errors only.
* **Headers:** `Runflow-Request-Id` is always sent. `Runflow-Signature` is sent if a signing secret is configured.

## Additional Resources

* [Playground](https://app.runflow.io/models/meta/sam-3/image)
* [API Reference](https://app.runflow.io/models/meta/sam-3/image?tab=api)
* [Documentation](https://docs.runflow.io)
* [OpenAPI](https://docs.runflow.io/api/openapi.public.json)

## Related

<CardGroup cols={2}>
  <Card title="Browse all models" icon="grid" href="/models">Browse the catalog.</Card>
  <Card title="Run lifecycle" icon="play" href="/concepts/runs">Callbacks, polling, statuses.</Card>
  <Card title="Callbacks" icon="webhook" href="/concepts/callbacks">Handle async results.</Card>
  <Card title="Pricing" icon="coin" href="/concepts/pricing">How requests bill out.</Card>
</CardGroup>