# Moondream3 Preview [Segment] API

> Segmentuje pojmenovaný objekt v obrázku a vrací masku, ohraničující rámeček a SVG cestu

Segmentuje objekt zadaný v `object` v obrázku na `image_url`. Výsledek může obsahovat obraz masky, ohraničující rámeček a data SVG cesty; pokud se nic nedetekuje, jsou hodnoty null. `spatial_references` může poskytnout body pro vedení segmentace a `settings` upravuje vzorkování. Nastavením `preview` získáte binární masku.

- Model id: `moondream3-preview/segment`
- Made by: Moondream
- Category: Image Editing
- Output: image
- Estimated price per run: $0.003 / run (cheapest run $0.003 (3 API credits))
- Run: `POST https://api.doitong.com/v1/run/moondream3-preview/segment`
- Quote: `POST https://api.doitong.com/v1/quote/moondream3-preview/segment`
- Docs page: https://doitong.com/cs/developers/models/moondream3-preview/segment

## Pricing

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

The full example input below costs $0.003 = 3 API credits (1 request × 3 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/moondream3-preview/segment` 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 odkazující na obrázek určený ke zpracování. |
| `object` |  | string | yes |  |  | Cílový objekt pro segmentaci v obrázku. |
| `spatial_references` |  | array of any \| null | no |  |  | Prostorové pokyny pro segmentaci zadané jako seznam objektů Point, jejichž členy jsou x a y, nebo jako seznam polí souřadnic. Každé pole musí obsahovat buď 2 desetinná čísla (x,y), nebo 4 desetinná čísla (x1,y1,x2,y2). |
| `settings` |  | object {temperature, top_p, max_tokens} \| null | no |  |  | Nastavení segmentačního modelu řídící vzorkování. |
| `settings.temperature` |  | number | no | `1` | 0 – 1 | Teplota vzorkování určuje rovnováhu mezi soustředěným, deterministickým výstupem při nízkých hodnotách a vyšší náhodností při vysokých hodnotách. |
| `settings.top_p` |  | number | no | `1` | 0 – 1 | Pravděpodobnostní hmotnost pro nucleus sampling v rozsahu 0 až 1. |
| `settings.max_tokens` |  | integer \| null | no |  | ≥ 1 | Horní limit vygenerovaných tokenů. |
| `preview` |  | boolean | no | `false` |  | Určuje, zda se spolu s náhledem výstupu vrátí binární maska obrázku. |

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",
  "object": "fox"
}
```

A fuller example:

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

## 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/moondream3-preview/segment?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",
    "object": "fox"
  }'

# 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/moondream3-preview/segment?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "object": "fox"
  }),
});
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",
    "object": "fox",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/moondream3-preview/segment", 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": "moondream3-preview/segment",
      "input": {
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "object": "fox"
      },
      "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": "moondream3-preview/segment",
  "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": 3,
    "usd": "0.003",
    "charged": 3,
    "refunded": 0
  },
  "input": {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "object": "fox"
  },
  "output": {
    "finish_reason": "stop",
    "usage_info": {
      "input_tokens": 1,
      "output_tokens": 1,
      "prefill_time_ms": 1.0,
      "decode_time_ms": 1.0,
      "ttft_ms": 1.0
    },
    "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
    },
    "path": "M.657,.996C.610,.984,.529,.938,.447,.875C.411,.848,.363,.815,.341,.802C.188,.714,.093,.623,.038,.511C.011,.455,.000,.406,.000,.340C.000,.269,.006,.234,.025,.186C.051,.123,.092,.079,.161,.042C.240,-0.000,.355,-0.011,.433,.017C.462,.027,.535,.066,.571,.091C.701,.180,.807,.265,.850,.311C.911,.379,.962,.468,.984,.545C.995,.585,.997,.601,.997,.664C.997,.765,.984,.811,.935,.879C.878,.958,.796,1.001,.705,1.000C.685,.999,.664,.998,.657,.996z",
    "bbox": {
      "x_min": 1.0,
      "y_min": 1.0,
      "x_max": 1.0,
      "y_max": 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 |
|---|---|---|
| `finish_reason` | string | Důvod ukončení generování výstupu. |
| `usage_info` | object {input_tokens, output_tokens, prefill_time_ms, decode_time_ms, ttft_ms} | Podrobnosti o využití požadavku. |
| `image` | object {url, content_type, file_name, file_size, width, height} \| null | Výsledek náhledu segmentace: null, pokud nebylo vyžádáno generování náhledu nebo detekce objektu nic nenašla; jinak obrázek obsahující masku. |
| `path` | string \| null | Data cesty SVG vrácená při detekci segmentační masky; jinak null. |
| `bbox` | object {x_min, y_min, x_max, y_max} \| null | Ohraničující rámeček vrácený pro detekovaný segmentovaný objekt; jinak null. |

## Related models

- [Moondream 3 Preview \[Query\]](https://doitong.com/developers/models/moondream3-preview/query.md) (`moondream3-preview/query`): $0.001 / run
- [Moondream3 Preview \[Caption\]](https://doitong.com/developers/models/moondream3-preview/caption.md) (`moondream3-preview/caption`): $0.002 / run
- [Moondream3 Preview \[Detect\]](https://doitong.com/developers/models/moondream3-preview/detect.md) (`moondream3-preview/detect`): $0.001 / run
- [Moondream3 Preview \[Point\]](https://doitong.com/developers/models/moondream3-preview/point.md) (`moondream3-preview/point`): $0.001 / run
- [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

## Links

- HTML page: https://doitong.com/developers/models/moondream3-preview/segment
- 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=moondream3-preview/segment
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/moondream3-preview/segment