# Sam 3 · 3D Align API

> يحاذي شبكة جسم SAM 3D مع مشهد الصورة المصدر، مع إمكانية دمجها اختياريًا مع شبكة كائن

يضع شبكة جسم بشري (.ply أو .glb) في الإحداثيات المكانية للصورة الأصلية، باستخدام تقدير العمق من `image_url`. تشمل المدخلات الاختيارية قناعًا بشريًا وقيمةً للبعد البؤري وشبكة كائن (.glb) تنتج ملف مشهد مركبًا. تتضمن المخرجات شبكات محاذاة بتنسيقي PLY وGLB وبيانات وصفية للمحاذاة وتمثيلًا مرئيًا تراكبيًا.

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

## 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-align` 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 للصورة المصدر لتقدير العمق باستخدام MoGe. |
| `body_mesh_url` |  | string | yes |  |  | عنوان URL للشبكة للمحاذاة، ويقبل ملف SAM-3D Body بصيغة .ply أو .glb. |
| `body_mask_url` |  | string (image URL) \| null | no |  |  | عنوان URL لصورة قناع البشر؛ يؤدي حذفه إلى استخدام الصورة بأكملها. |
| `object_mesh_url` |  | string \| null | no |  |  | عنوان URL اختياري لشبكة SAM-3D Object بصيغة .glb، يُستخدم لإنشاء مشهد مدمج. |
| `focal_length` |  | number \| null | no |  |  | تجاوز البعد البؤري المستمد من بيانات SAM-3D Body الوصفية، مع استخدام تقدير MoGe عند عدم توفير قيمة. |

File parameters (`image`, `body_mask_url`) 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",
  "body_mesh_url": "https://example.com/your-file.glb"
}
```

A fuller example:

```json
{
  "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "body_mesh_url": "https://example.com/your-file.glb"
}
```

## 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-align?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",
    "body_mesh_url": "https://example.com/your-file.glb"
  }'

# 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-align?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "body_mesh_url": "https://example.com/your-file.glb"
  }),
});
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",
    "body_mesh_url": "https://example.com/your-file.glb",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/sam-3/3d-align", 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-align",
      "input": {
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "body_mesh_url": "https://example.com/your-file.glb"
      },
      "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-align",
  "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",
    "body_mesh_url": "https://example.com/your-file.glb"
  },
  "output": {
    "body_mesh_ply": {
      "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
    },
    "visualization": {
      "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": {
      "person_id": 1,
      "scale_factor": 1.0,
      "translation": [
        1.0
      ],
      "focal_length": 1.0,
      "target_points_count": 1,
      "cropped_vertices_count": 1
    },
    "scene_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
    }
  },
  "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 |
|---|---|---|
| `body_mesh_ply` | object {url, content_type, file_name, file_size} | ملف PLY يحتوي على شبكة الجسم المُحاذاة. |
| `model_glb` | object {url, content_type, file_name, file_size} | ملف GLB يحتوي على شبكة الجسم المُحاذاة لمعاينة ثلاثية الأبعاد. |
| `visualization` | object {url, content_type, file_name, file_size} | تصوير بصري للصورة المدخلة مع تراكب الشبكة المُحاذاة. |
| `metadata` | object {person_id, scale_factor, translation, focal_length, target_points_count, cropped_vertices_count} | تفاصيل المحاذاة، مثل القياس والإزاحة. |
| `scene_glb` | object {url, content_type, file_name, file_size} \| null | مخرج GLB متاح فقط عند توفير object_mesh_url؛ ويحتوي على شبكتي الجسم والكائن معًا في مشهد واحد. |

## 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 Objects](https://doitong.com/developers/models/sam-3/3d-objects.md) (`sam-3/3d-objects`): $0.02 / run
- [Sam 3 · Image · Embed](https://doitong.com/developers/models/sam-3/image/embed.md) (`sam-3/image/embed`): $0.005 / run
- [Abot World 0](https://doitong.com/developers/models/alibaba/abot-world-0.md) (`alibaba/abot-world-0`): $0.001 / run

## Links

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