# Product Placement

> Composite 1–4 product reference images into a room or outdoor scene photo, with optional brushed-area or text guidance. Preserves the source scene and matches the product to existing lighting, scale, and perspective.

## Overview

- **Endpoint**: `https://queue.modelrunner.run/roomix/product-placement`
- **Wrapper ID**: `roomix/product-placement`
- **Category**: image-to-image
- **Kind**: wrapper inference
- **Tags**: roomix, interior, exterior, product, compositing

## Pricing

- **Estimated Price**: $0.08766667 average per output

## Request Lifecycle

This wrapper runs on the ModelRunner **asynchronous queue API** — a single POST does not return the output. Every call requires an `Authorization: Key $MODEL_RUNNER_KEY` header. Run three steps:

1. **Submit** — `POST https://queue.modelrunner.run/roomix/product-placement` with a JSON body holding the input fields at the top level. The body may also include a reserved top-level `metadata` object — a flat string map (max 16 keys, key ≤64 / value ≤512 chars) stored on the request for your own tagging. It is never sent to the wrapper; filter your request history with `GET https://queue.modelrunner.run/requests?metadata=<url-encoded JSON>` (exact key=value matches, AND-ed). The response carries request handles only (no output yet):

```json
{
  "status": "IN_QUEUE",
  "request_id": "<21-char id>",
  "status_url": "https://queue.modelrunner.run/roomix/product-placement/requests/<request_id>/status",
  "response_url": "https://queue.modelrunner.run/roomix/product-placement/requests/<request_id>",
  "cancel_url": "https://queue.modelrunner.run/roomix/product-placement/requests/<request_id>/cancel"
}
```

2. **Poll status** — `GET <status_url>` until `status` is `COMPLETED`. Possible values are `IN_QUEUE`, `IN_PROGRESS`, `COMPLETED`, `FAILED`, `CANCELLED`. A `FAILED` request responds with HTTP 400 and an `error` field.

3. **Read result** — `GET <response_url>`. Returns the finished request, including the generated `output`:

```json
{ "id": "<request_id>", "status": "COMPLETED", "output": ..., "input": ... }
```

The JavaScript and Python SDKs below perform steps 2–3 for you. In any language without an SDK (Swift, Go, Kotlin, etc.) you must implement the polling loop and the final result fetch yourself — see the cURL example for the full flow.

### Input Schema

- **`prompt`** (`string`, _optional_):
  Optional natural-language placement guidance (e.g. 'on the left wall, next to the sofa'). Leave blank to let the model choose the most natural placement.

- **`file_url`** (`string`, _required_):
  URL of the room or outdoor scene photo to place products into.

- **`image_size`** (`string`, _optional_):
  Output image size preset. \`auto\` matches the source photo's aspect.
  - Default: `"auto"`
  - Options: `"auto"`, `"1_1_1k"`, `"1_1_2k"`, `"16_9_1k"`, `"16_9_2k"`, `"9_16_1k"`, `"9_16_2k"`, `"4_3_1k"`, `"4_3_2k"`, `"3_4_1k"`, `"3_4_2k"`, `"3_2_1k"`, `"3_2_2k"`, `"2_3_1k"`, `"2_3_2k"`, `"4_5_1k"`, `"4_5_2k"`, `"5_4_1k"`, `"5_4_2k"`

- **`brushed_url`** (`string`, _optional_):
  Optional copy of the source scene with bright-yellow brush strokes marking where the product should go. Only effective with a single product reference.

- **`product_urls`** (`array<string>`, _required_):
  1–4 product reference image URLs. Each is treated as a distinct product to place in the scene.

### Output Schema

_No `Output` schema properties are available._

## Default Example

**Output**

```json
"eiUYzqPBXXX7ST90XVa4y"
```
## Usage Examples

### cURL

The queue API is asynchronous: submit the request, poll `status_url` until it is `COMPLETED`, then read the result from `response_url`. Requires `jq`.

```bash
# 1. Submit the request (returns request handles, not the output)
SUBMIT=$(curl --silent --request POST \
  --url https://queue.modelrunner.run/roomix/product-placement \
  --header "Authorization: Key $MODEL_RUNNER_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "file_url": "",
  "product_urls": []
}')

STATUS_URL=$(echo "$SUBMIT" | jq -r '.status_url')
RESPONSE_URL=$(echo "$SUBMIT" | jq -r '.response_url')

# 2. Poll until the request leaves the queue / in-progress state
while true; do
  STATUS=$(curl --silent --url "$STATUS_URL" \
    --header "Authorization: Key $MODEL_RUNNER_KEY" | jq -r '.status')
  echo "Status: $STATUS"
  case "$STATUS" in
    COMPLETED) break ;;
    FAILED|CANCELLED) echo "Request $STATUS"; exit 1 ;;
  esac
  sleep 1
done

# 3. Read the finished request, including the generated output
curl --silent --url "$RESPONSE_URL" \
  --header "Authorization: Key $MODEL_RUNNER_KEY"
```

### JavaScript

```javascript
import { modelrunner } from "@modelrunner/client";

const result = await modelrunner.subscribe("roomix/product-placement", {
  input: {
  "file_url": "",
  "product_urls": []
}
});

console.log(result.data);
```

### Python

```python
import asyncio
import modelrunner_ai

async def main():
    response = await modelrunner_ai.submit_async(
        "roomix/product-placement",
        arguments={
  "file_url": "",
  "product_urls": []
}
    )
    result = await response.get()
    print(result["output"])

asyncio.run(main())
```

## Additional Resources

- [Playground](https://modelrunner.ai/wrappers/roomix/product-placement)
- [OpenAPI Schema](https://modelrunner.ai/wrappers/roomix/product-placement/openapi.json)
- [LLM Instructions](https://modelrunner.ai/wrappers/roomix/product-placement/llms.txt)