# Segment Anything Model 3 API

> متن، پوائنٹ یا باکس پرامپٹ سے تصویر کی سیگمنٹیشن کرتا ہے اور ماسک تصاویر واپس کرتا ہے، اختیاری اسکورز اور باکسز کے ساتھ

متنی `prompt`، `point_prompts` یا `box_prompts` سے SAM 3 کے ذریعے تصویر کو سیگمنٹ کرتا ہے۔ `return_multiple_masks` فعال ہونے پر زیادہ سے زیادہ `max_masks` ماسکس واپس کرتا ہے (1 سے 32)۔ اختیاری اعتماد اسکورز اور باؤنڈنگ باکسز شامل کیے جا سکتے ہیں۔ آؤٹ پٹ فارمیٹ jpeg، png یا webp ہے۔

- Model id: `sam-3/image`
- Made by: Meta
- Category: Image Editing
- Output: image
- 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`
- Quote: `POST https://api.doitong.com/v1/quote/sam-3/image`
- Docs page: https://doitong.com/ur/developers/models/sam-3/image

## 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` 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۔ |
| `prompt` |  | string | no | `wheel` |  | سیگمنٹیشن کی رہنمائی کرنے والی متنی ہدایت۔ |
| `text_prompt` |  | string \| null | no |  |  | [DEPRECATED] پسماندہ مطابقت کے لیے برقرار رکھا گیا پرانا ان پٹ؛ اس کی جگہ 'prompt' استعمال کریں۔ |
| `point_prompts` |  | array of object {x, y, label, object_id, frame_index} | no | `[]` |  | نقطہ پر مبنی پرامپٹس کا مجموعہ۔ |
| `point_prompts[].x` |  | integer \| null | no |  |  | X محور پر پرامپٹ کی پوزیشن۔ |
| `point_prompts[].y` |  | integer \| null | no |  |  | Y محور پر پرامپٹ کی پوزیشن۔ |
| `point_prompts[].label` |  | enum (integer) \| null | no |  | `0`, `1` | پیش منظر/پس منظر کا لیبل: 1 پیش منظر اور 0 پس منظر ظاہر کرتا ہے۔ |
| `point_prompts[].object_id` |  | integer \| null | no |  |  | ایک آبجیکٹ کو بہتر بنانے والے پرامپٹس کو گروپ کرنے کے لیے اختیاری شناخت کنندہ۔ اگر متن بھی پرامپٹ کے طور پر فراہم کیا جائے تو یہ شناخت کنندہ طے کرتا ہے کہ دریافت شدہ کون سا آبجیکٹ ان نقاط سے بہتر کیا جائے۔ |
| `point_prompts[].frame_index` |  | integer \| null | no |  |  | تعامل کے لیے فریم کی شناخت کرنے والا انڈیکس۔ |
| `box_prompts` |  | array of object {x_min, y_min, x_max, y_max, object_id, frame_index} | no | `[]` |  | باکس پرامپٹس جن کی object_id گروپ بندی متعین کرتی ہے: مماثل IDs باکسز کو ایک آبجیکٹ سے وابستہ کرتے ہیں، جبکہ خالی IDs الگ الگ آبجیکٹس ظاہر کرتے ہیں۔ متعدد باکسز فراہم کیے جا سکتے ہیں، ہر ایک coordinates (x_min, y_min, x_max, y_max) استعمال کرتا ہے۔ |
| `box_prompts[].x_min` |  | integer \| null | no |  |  | باکس کے لیے کم از کم x-coordinate۔ |
| `box_prompts[].y_min` |  | integer \| null | no |  |  | باکس کے لیے کم از کم y-coordinate۔ |
| `box_prompts[].x_max` |  | integer \| null | no |  |  | باکس کے لیے زیادہ سے زیادہ X coordinate۔ |
| `box_prompts[].y_max` |  | integer \| null | no |  |  | باکس کے لیے زیادہ سے زیادہ Y coordinate۔ |
| `box_prompts[].object_id` |  | integer \| null | no |  |  | ایک آبجیکٹ کو بہتر بنانے والے باکسز کو گروپ کرنے کے لیے اختیاری شناخت کنندہ۔ |
| `box_prompts[].frame_index` |  | integer \| null | no |  |  | تعامل کے لیے فریم کی شناخت کرنے والا انڈیکس۔ |
| `apply_mask` |  | boolean | no | `true` |  | کنٹرول کرتا ہے کہ تصویر پر ماسک لاگو کیا جائے یا نہیں۔ |
| `output_format` |  | enum (string) | no | `png` | `jpeg`, `png`, `webp` | نتیجہ خیز تصویر کا فائل فارمیٹ۔ |
| `return_multiple_masks` |  | boolean | no | `false` |  | متعدد ماسک واپس کرنے کا اختیار: اسے فعال کرنے پر `max_masks` طے کرتا ہے کہ کتنے تخلیق کردہ ماسک اپ لوڈ کر کے جواب میں شامل کیے جائیں۔ |
| `max_masks` |  | integer | no | `3` | 1 – 32 | `return_multiple_masks` فعال ہونے پر واپس کیے جانے والے ماسکس کی زیادہ سے زیادہ حد۔ |
| `include_scores` |  | boolean | no | `false` |  | ماسکس کے لیے اعتماد کے اسکور شامل کرنے کو کنٹرول کرتا ہے۔ |
| `include_boxes` |  | boolean | no | `false` |  | دستیاب ہونے کی صورت میں ہر ماسک کے لیے bounding box شامل کرنے کو کنٹرول کرتا ہے۔ |

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?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?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", 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",
      "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",
  "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": {
    "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.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `image` | object {url, content_type, file_name, file_size, width, height} \| null | بنیادی سیگمنٹیشن ماسک دکھانے والا پیش نظارہ۔ |
| `masks` | array of object {url, content_type, file_name, file_size, width, height} | سیگمنٹیشن ماسکس پر مشتمل تصاویر۔ |
| `metadata` | array of object {index, score, box} \| null | ہر ماسک کے لیے میٹا ڈیٹا، جس میں اس کا اسکور اور باکس شامل ہیں۔ |
| `scores` | array of number \| null | ہر ماسک کا اعتماد اسکور، درخواست کیے جانے پر فراہم کیا جاتا ہے۔ |
| `boxes` | array of array of number \| null | ہر ماسک کے لیے نارملائزڈ باکس، درخواست کیے جانے پر [cx, cy, w, h] کے طور پر ظاہر کیے جاتے ہیں۔ |

## Related models

- [Sam 3 · Image RLE](https://doitong.com/developers/models/sam-3/image-rle.md) (`sam-3/image-rle`): $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
- 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
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/sam-3/image