# Sam 3 · 3D Objects API

> 從影像重建 3D 物件，可透過文字、點或框提示或遮罩選取，並輸出 splat

將照片中的物件轉換為 3D 資產。使用 `mask_urls`、文字 `prompt`、`point_prompts` 或 `box_prompts` 選取物件；多個框會產生分開的物件。`detection_threshold` 接受 0.1 到 1，`export_textured_glb` 會烘焙紋理和 UV。輸出包括 GLB、Gaussian splat 檔案、多物件場景的個別物件檔案、中繼資料及 zip 套件。

- Model id: `sam-3/3d-objects`
- Made by: Meta
- Category: Image to 3D
- Output: 3d
- Estimated price per run: $0.02 / run (cheapest run $0.02 (20 API credits))
- Run: `POST https://api.doitong.com/v1/run/sam-3/3d-objects`
- Quote: `POST https://api.doitong.com/v1/quote/sam-3/3d-objects`
- Docs page: https://doitong.com/zh-TW/developers/models/sam-3/3d-objects

## Pricing

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

The full example input below costs $0.02 = 20 API credits (1 request × 20 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/3d-objects` 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 |  |  | 用於 3D 重建的圖像 URL。 |
| `mask_urls` |  | array of image URL | no |  |  | 選用的每個物件遮罩 URL 清單。沒有遮罩時，如果有提供提示詞、point_prompts 或 box_prompts，則自動分割會使用這些提示詞；若未提供遮罩或分割提示詞，則使用整張圖像。 |
| `prompt` |  | string \| null | no | `car` |  | 遮罩不存在時用於自動分割的文字，例如 'chair' 或 'lamp'。 |
| `point_prompts` |  | array of object {x, y, label, object_id} | 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 |  |  | 將用於細化單一物件的提示詞分組之選用識別碼。如果也提供文字作為提示詞，此識別碼會決定這些點要細化哪個偵測到的物件。 |
| `box_prompts` |  | array of object {x_min, y_min, x_max, y_max, object_id} | no | `[]` |  | 透過自動分割產生個別物件遮罩的框提示詞，用於 3D 重建；僅在未提供遮罩時使用。可提交多個框。 |
| `box_prompts[].x_min` |  | integer \| null | no |  |  | 框的最小 x 座標。 |
| `box_prompts[].y_min` |  | integer \| null | no |  |  | 框的最小 y 座標。 |
| `box_prompts[].x_max` |  | integer \| null | no |  |  | 框的最大 X 座標。 |
| `box_prompts[].y_max` |  | integer \| null | no |  |  | 框的最大 Y 座標。 |
| `box_prompts[].object_id` |  | integer \| null | no |  |  | 將用於細化單一物件的框分組之選用識別碼。 |
| `seed` |  | integer \| null | no |  |  | 用於可重現隨機生成的種子。 |
| `pointmap_url` |  | string \| null | no |  |  | 選用 URL，透過提供 NPY 或 NPZ 格式的外部 pointmap 或深度資料，改善 3D 重建中的深度估計。 |
| `detection_threshold` |  | number \| null | no |  | 0.1 – 1 | 偵測信心門檻；省略時使用模型的預設值。值的範圍為 0.1 至 1.0，較小的值會以精確度換取更多偵測結果。 |
| `export_textured_glb` |  | boolean | no | `false` |  | GLB 匯出選項：啟用此選項會以烘焙紋理和 UV 取代頂點顏色。 |

File parameters (`image`, `mask_urls`) 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/3d-objects?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/3d-objects?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/3d-objects", 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/3d-objects",
      "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/3d-objects",
  "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": 20,
    "usd": "0.02",
    "charged": 20,
    "refunded": 0
  },
  "input": {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  },
  "output": {
    "gaussian_splat": {
      "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
    },
    "model_glb": {
      "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": [
      {
        "object_index": 1,
        "scale": [
          []
        ],
        "rotation": [
          []
        ],
        "translation": [
          []
        ],
        "camera_pose": [
          []
        ]
      }
    ],
    "individual_splats": [
      {
        "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
      }
    ],
    "individual_glbs": [
      {
        "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
      }
    ],
    "artifacts_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
    }
  },
  "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 |
|---|---|---|
| `gaussian_splat` | object {url, content_type, file_name, file_size} | 包含多個物件之結果的合併場景 splat，否則為單一 splat；以 .ply 格式的 Gaussian splat 檔案提供。 |
| `model_glb` | object {url, content_type, file_name, file_size} | 以 GLB 儲存的 3D 輸出：多個物件會組合成一個場景，其他結果則包含一個網格。 |
| `metadata` | array of object {object_index, scale, rotation, translation, camera_pose} | 每個物件的中繼資料，包括旋轉、位移和縮放。 |
| `individual_splats` | array of object {url, content_type, file_name, file_size} \| null | 每個物件的獨立 Gaussian splat 檔案，僅在包含多個物件的場景中提供。 |
| `individual_glbs` | array of object {url, content_type, file_name, file_size} \| null | 每個物件的獨立 GLB 網格檔案，僅在包含多個物件的場景中提供。 |
| `artifacts_zip` | object {url, content_type, file_name, file_size} \| null | 所有成品及中繼資料的 ZIP 封存檔。 |

## Related models

- [Sam 3 · Image RLE](https://doitong.com/developers/models/sam-3/image-rle.md) (`sam-3/image-rle`): $0.005 / run
- [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 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
- [Hi3D Image to 3D](https://doitong.com/developers/models/hitem3d/hi3d/image-to-3d.md) (`hitem3d/hi3d/image-to-3d`): $0.50 / run

## Links

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