# Sam 3 · Image RLE API

> Segmentation d’image qui retourne le masque sous forme de données codées en longueurs de séquences plutôt qu’en image

Effectue la segmentation SAM 3 d’une image avec une `prompt` textuelle, des points ou des boîtes, et retourne le masque sous forme de données codées en longueurs de séquences (RLE). Utile lorsque vous avez besoin de données de masque compactes pour le post-traitement. Prend en charge `return_multiple_masks` avec `max_masks` de 1 à 32, ainsi que les scores et boîtes facultatifs.

- Model id: `sam-3/image-rle`
- Made by: Meta
- Category: Image Editing
- Output: json
- Estimated price per run: $0.005 / run (cheapest run $0.005 (5 API credits))
- Run: `POST https://api.doitong.com/v1/run/sam-3/image-rle`
- Quote: `POST https://api.doitong.com/v1/quote/sam-3/image-rle`
- Docs page: https://doitong.com/fr-CA/developers/models/sam-3/image-rle

## Pricing

Price: **$0.005 / run**. Estimated from the typical cost of one run. The quote is exactly what the run charges.

The full example input below costs $0.005 = 5 API credits (1 request × 5 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/sam-3/image-rle` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `image_url` | `image` | string (image URL) | yes |  |  | URL pointant vers l’image à segmenter. |
| `prompt` |  | string | no | `wheel` |  | Instruction textuelle guidant la segmentation. |
| `text_prompt` |  | string \| null | no |  |  | [DEPRECATED] Entrée héritée conservée pour la rétrocompatibilité; utilisez 'prompt' à sa place. |
| `point_prompts` |  | array of object {x, y, label, object_id, frame_index} | no | `[]` |  | Collection d’invites fondées sur des points. |
| `point_prompts[].x` |  | integer \| null | no |  |  | Position de l’invite sur l’axe X. |
| `point_prompts[].y` |  | integer \| null | no |  |  | Position de l’invite sur l’axe Y. |
| `point_prompts[].label` |  | enum (integer) \| null | no |  | `0`, `1` | Étiquette premier plan/arrière-plan : 1 indique le premier plan; 0 indique l’arrière-plan. |
| `point_prompts[].object_id` |  | integer \| null | no |  |  | Identifiant facultatif regroupant les invites qui affinent un seul objet. Si du texte est également fourni comme invite, cet identifiant détermine l’objet détecté que ces points affinent. |
| `point_prompts[].frame_index` |  | integer \| null | no |  |  | Index identifiant l’image avec laquelle interagir. |
| `box_prompts` |  | array of object {x_min, y_min, x_max, y_max, object_id, frame_index} | no | `[]` |  | Invites de boîte dont object_id détermine le regroupement : des ID correspondants associent les boîtes à un même objet, tandis que les ID vides représentent des objets distincts. Plusieurs boîtes peuvent être fournies, chacune utilisant les coordonnées (x_min, y_min, x_max, y_max). |
| `box_prompts[].x_min` |  | integer \| null | no |  |  | Coordonnée x minimale de la boîte. |
| `box_prompts[].y_min` |  | integer \| null | no |  |  | Coordonnée y minimale de la boîte. |
| `box_prompts[].x_max` |  | integer \| null | no |  |  | Coordonnée X maximale de la boîte. |
| `box_prompts[].y_max` |  | integer \| null | no |  |  | Coordonnée Y maximale de la boîte. |
| `box_prompts[].object_id` |  | integer \| null | no |  |  | Identifiant facultatif regroupant les boîtes qui affinent un seul objet. |
| `box_prompts[].frame_index` |  | integer \| null | no |  |  | Index identifiant l’image avec laquelle interagir. |
| `apply_mask` |  | boolean | no | `true` |  | Contrôle l’application du masque à l’image. |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | Format de fichier de l’image obtenue. |
| `return_multiple_masks` |  | boolean | no | `false` |  | Option de retour de plusieurs masques : son activation utilise `max_masks` pour déterminer le nombre de masques générés à téléverser et à inclure dans la réponse. |
| `max_masks` |  | integer | no | `3` | 1 – 32 | Limite supérieure du nombre de masques retournés lorsque `return_multiple_masks` est activé. |
| `include_scores` |  | boolean | no | `false` |  | Contrôle l’inclusion des scores de confiance des masques. |
| `include_boxes` |  | boolean | no | `false` |  | Contrôle l’inclusion d’une boîte englobante pour chaque masque, si disponible. |

File parameters (`image`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "image": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

A fuller example:

```json
{
  "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/sam-3/image-rle?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/sam-3/image-rle?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/sam-3/image-rle", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "sam-3/image-rle",
      "input": {
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "sam-3/image-rle",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 5,
    "usd": "0.005",
    "charged": 5,
    "refunded": 0
  },
  "input": {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  },
  "output": {
    "rle": "string",
    "boundingbox_frames_zip": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_name": "0-output.jpeg",
      "file_size": 1843200
    },
    "metadata": [
      {
        "index": 1,
        "score": 1.0,
        "box": [
          1.0
        ]
      }
    ],
    "scores": [
      1.0
    ],
    "boxes": [
      [
        1.0
      ]
    ]
  },
  "outputs": [
    {
      "type": "file",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `rle` | string \| array of string | Masque représenté à l’aide d’un encodage par plages. |
| `boundingbox_frames_zip` | object {url, content_type, file_name, file_size} \| null | Archive ZIP des superpositions de boîtes englobantes pour chaque image. |
| `metadata` | array of object {index, score, box} \| null | Métadonnées pour chaque masque, incluses lorsque la réponse contient plusieurs RLE. |
| `scores` | array of number \| null | Score de confiance pour chaque masque, fourni sur demande. |
| `boxes` | array of array of number \| null | Boîtes normalisées pour chaque masque, exprimées comme [cx, cy, w, h], sur demande. |

## Related models

- [Segment Anything Model 3](https://doitong.com/developers/models/sam-3/image.md) (`sam-3/image`): $0.005 / run
- [Sam 3 · Video](https://doitong.com/developers/models/sam-3/video.md) (`sam-3/video`): $0.005 / 16 frames of input video
- [Sam 3 · Video RLE](https://doitong.com/developers/models/sam-3/video-rle.md) (`sam-3/video-rle`): $0.005 / 16 frames of input video
- [Sam 3 · 3D Body](https://doitong.com/developers/models/sam-3/3d-body.md) (`sam-3/3d-body`): $0.02 / run
- [Sam 3 · 3D Objects](https://doitong.com/developers/models/sam-3/3d-objects.md) (`sam-3/3d-objects`): $0.02 / run
- [Sam 3 · 3D Align](https://doitong.com/developers/models/sam-3/3d-align.md) (`sam-3/3d-align`): $0.02 / run
- [Sam 3 · Image · Embed](https://doitong.com/developers/models/sam-3/image/embed.md) (`sam-3/image/embed`): $0.005 / run
- [FLUX.1 Kontext \[pro\]](https://doitong.com/developers/models/flux-pro/kontext.md) (`flux-pro/kontext`): $0.04 / image

## Links

- HTML page: https://doitong.com/developers/models/sam-3/image-rle
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=sam-3/image-rle
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/sam-3/image-rle