# Sam 3 1 · Image API

> Sgaradh ìomhaighe SAM 3.1 bho prompts teacsa, puing no bogsa, a’ tilleadh ìomhaighean masg

Sgaraidh e aon ìomhaigh le SAM 3.1 a’ cleachdadh `prompt` teacsa, `point_prompts` no `box_prompts`. Faodar grunn bhogsaichean a chur còmhla gach nì le object_id. Tillidh `return_multiple_masks` suas ri `max_masks` masgan (1 gu 32), le sgòran agus bogsaichean crìche roghainneil. ’S e jpeg, png no webp an cruth toraidh.

- Model id: `sam-3-1/image`
- Made by: Meta
- Category: Image Editing
- Output: image
- Estimated price per run: $0.01 / run (cheapest run $0.01 (10 API credits))
- Run: `POST https://api.doitong.ru/v1/run/sam-3-1/image`
- Quote: `POST https://api.doitong.ru/v1/quote/sam-3-1/image`
- Docs page: https://doitong.com/gd/developers/models/sam-3-1/image

## Pricing

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

The full example input below costs $0.01 = 10 API credits (1 request × 10 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.ru/v1/quote/sam-3-1/image` 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 a’ comharrachadh na h-ìomhaigh airson sgaradh. |
| `prompt` |  | string | no | `wheel` |  | Stiùireadh teacsa a tha a’ stiùireadh sgaradh. |
| `point_prompts` |  | array of object {x, y, label, object_id, frame_index} | no | `[]` |  | Cruinneachadh de phrompts stèidhichte air puingean. |
| `point_prompts[].x` |  | integer \| null | no |  |  | Suidheachadh a’ phrompt air an axis X. |
| `point_prompts[].y` |  | integer \| null | no |  |  | Suidheachadh a’ phrompt air an axis Y. |
| `point_prompts[].label` |  | enum (integer) \| null | no |  | `0`, `1` | Bileag aghaidh/chùlaibh: tha 1 a’ comharrachadh aghaidh; tha 0 a’ comharrachadh cùlaibh. |
| `point_prompts[].object_id` |  | integer \| null | no |  |  | Aithniche roghainneil a bhios a’ buidhneachadh phrompts a leasaicheas aon nì. Ma tha teacsa air a thoirt seachad mar prompt cuideachd, bidh an aithnichear seo a’ dearbhadh dè an nì a chaidh a lorg a bhios na puingean sin a’ leasachadh. |
| `point_prompts[].frame_index` |  | integer \| null | no |  |  | Clàr-amais a’ comharrachadh an fhrèam airson eadar-obrachadh. |
| `box_prompts` |  | array of object {x_min, y_min, x_max, y_max, object_id, frame_index} | no | `[]` |  | Prompts bhogsa aig a bheil object_id a’ dearbhadh a’ bhuidhneachaidh: bidh IDan co-ionann a’ ceangal bhogsaichean ri aon nì, agus bidh IDan falamh a’ riochdachadh nithean fa leth. Faodar iomadh bogsa a thoirt seachad, gach fear a’ cleachdadh co-chomharran (x_min, y_min, x_max, y_max). |
| `box_prompts[].x_min` |  | integer \| null | no |  |  | Co-chomharran x as lugha airson a’ bhogsa. |
| `box_prompts[].y_min` |  | integer \| null | no |  |  | Co-chomharran y as lugha airson a’ bhogsa. |
| `box_prompts[].x_max` |  | integer \| null | no |  |  | Co-chomharran X as àirde airson a’ bhogsa. |
| `box_prompts[].y_max` |  | integer \| null | no |  |  | Co-chomharran Y as àirde airson a’ bhogsa. |
| `box_prompts[].object_id` |  | integer \| null | no |  |  | Aithniche roghainneil a bhios a’ buidhneachadh bhogsaichean a leasaicheas aon nì. |
| `box_prompts[].frame_index` |  | integer \| null | no |  |  | Clàr-amais a’ comharrachadh an fhrèam airson eadar-obrachadh. |
| `apply_mask` |  | boolean | no | `true` |  | Smachd air co-dhiù a bheil am masg air a chur an sàs san ìomhaigh. |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | Cruth faidhle na h-ìomhaigh a thig às. |
| `return_multiple_masks` |  | boolean | no | `false` |  | Roghainn tilleadh ioma-mhasga: le bhith ga chomasachadh cleachdaidh e `max_masks` gus dearbhadh cia mheud masg gineadaichte a thèid a luchdadh suas agus a thoirt a-steach don fhreagairt. |
| `max_masks` |  | integer | no | `3` | 1 – 32 | Crìoch àrd air na masgan a thèid a thilleadh nuair a tha `return_multiple_masks` comasach. |
| `include_scores` |  | boolean | no | `false` |  | Smachd air in-ghabhail sgòran misneachd airson masgan. |
| `include_boxes` |  | boolean | no | `false` |  | Smachd air in-ghabhail bogsa cuibhreachaidh airson gach masg, ma tha e ri fhaighinn. |

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.ru/v1/run/sam-3-1/image?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.ru/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.ru/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-1/image?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.ru/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-1/image", 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.ru/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-1/image",
      "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-1/image",
  "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": 10,
    "usd": "0.01",
    "charged": 10,
    "refunded": 0
  },
  "input": {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  },
  "output": {
    "image": {
      "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,
      "width": 1024,
      "height": 768
    },
    "masks": [
      {
        "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,
        "width": 1024,
        "height": 768
      }
    ],
    "metadata": [
      {
        "index": 1,
        "score": 1.0,
        "box": [
          1.0
        ]
      }
    ],
    "scores": [
      1.0
    ],
    "boxes": [
      [
        1.0
      ]
    ]
  },
  "outputs": [
    {
      "type": "image",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "width": 1024,
      "height": 768,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `image` | object {url, content_type, file_name, file_size, width, height} \| null | Ro-shealladh a’ sealltainn a’ phrìomh mhasg sgaradh. |
| `masks` | array of object {url, content_type, file_name, file_size, width, height} | Ìomhaighean anns a bheil masgan sgaradh. |
| `metadata` | array of object {index, score, box} \| null | Meata-dàta airson gach masg, a’ gabhail a-steach a sgòr agus a bhogsa. |
| `scores` | array of number \| null | Sgòr earbsa airson gach masg, air a thoirt seachad nuair a thèid iarraidh. |
| `boxes` | array of array of number \| null | Bogsaichean àbhaisteach airson gach masg, air an cur an cèill mar [cx, cy, w, h], ma thèid iarraidh. |

## Related models

- [Sam 3 1 · Image RLE](https://doitong.com/developers/models/sam-3-1/image-rle.md) (`sam-3-1/image-rle`): $0.01 / run
- [Sam 3 1 · Video](https://doitong.com/developers/models/sam-3-1/video.md) (`sam-3-1/video`): $0.01 / 16 frames of input video
- [Sam 3 1 · Video RLE](https://doitong.com/developers/models/sam-3-1/video-rle.md) (`sam-3-1/video-rle`): $0.01 / 16 frames of input video
- [FLUX.1 Kontext \[pro\]](https://doitong.com/developers/models/flux-pro/kontext.md) (`flux-pro/kontext`): $0.04 / image
- [GPT Image 2.5 Edit](https://doitong.com/developers/models/openai/gpt-image-2.5/flare/edit.md) (`openai/gpt-image-2.5/flare/edit`): from $0.12 / image
- [Nano Banana 2 Edit](https://doitong.com/developers/models/nano-banana-2/edit.md) (`nano-banana-2/edit`): from $0.06 / image
- [Nano Banana Pro Edit](https://doitong.com/developers/models/nano-banana-pro/edit.md) (`nano-banana-pro/edit`): from $0.15 / image
- [Qwen Image 3 Edit](https://doitong.com/developers/models/alibaba/qwen-image-3/edit.md) (`alibaba/qwen-image-3/edit`): from $0.04 / image

## Links

- HTML page: https://doitong.com/developers/models/sam-3-1/image
- 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-1/image
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.ru/v1/models/sam-3-1/image