# Room Redesign

> Redesign interior spaces from an uploaded image with controllable type, style, palette, lighting, material, and creativity.

## Overview

- **Endpoint**: `https://queue.modelrunner.run/roomix/room-redesign`
- **Wrapper ID**: `roomix/room-redesign`
- **Category**: image-to-image
- **Kind**: wrapper inference
- **Tags**: interior-design, home-design, room-redesign, image-edit, architecture

## 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/room-redesign` 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/room-redesign/requests/<request_id>/status",
  "response_url": "https://queue.modelrunner.run/roomix/room-redesign/requests/<request_id>",
  "cancel_url": "https://queue.modelrunner.run/roomix/room-redesign/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

- **`type`** (`string`, _optional_):
  The type of interior space to create.
  - Default: `"no-type"`
  - Options: `"no-type"`, `"living-room"`, `"kitchen"`, `"bedroom"`, `"bathroom"`, `"attic"`, `"dining-room"`, `"study-room"`, `"home-office"`, `"gaming-room"`, `"meeting-room"`, `"workshop"`, `"fitness-gym"`, `"coffee-shop"`, `"clothing-store"`, `"walk-in-closet"`, `"toilet"`, `"restaurant"`, `"office"`, `"coworking-space"`, `"hotel-lobby"`, `"hotel-room"`, `"hotel-bathroom"`, `"exhibition-space"`, `"onsen"`, `"mudroom"`

- **`color`** (`string`, _optional_):
  Preferred color palette for the redesign.
  - Default: `"auto"`
  - Options: `"warm-earth-tones"`, `"historical-romance"`, `"laid-back-blues"`, `"palm-springs-modern"`, `"sweet-pastels"`, `"rich-jewel-tones"`, `"desert-chic"`, `"forest-inspired"`, `"high-contrast-neutrals"`, `"airy-neutrals"`, `"coastal-neutrals"`, `"ecletic-boho"`, `"auto"`

- **`style`** (`string`, _optional_):
  The desired visual design style for the redesigned space.
  - Default: `"no-style"`
  - Options: `"no-style"`, `"minimalist-haven"`, `"modern-fusion"`, `"contemporary-elegance"`, `"industrial-loft"`, `"bohemian-oasis"`, `"coastal-breeze"`, `"desert-retreat"`, `"mountain-escape"`, `"victorian-elegance"`, `"art-deco-glamour"`, `"mid-century-modern"`, `"french-country-charm"`, `"colonial-classic"`, `"scandinavian-sanctuary"`, `"japanese-zen"`, `"moroccan-mystique"`, `"mediterranean-retreat"`, `"indian-exuberance"`, `"travelers-trove"`, `"cyber-eclectic-fusion"`, `"neon-noir"`, `"techno-wonderland"`, `"retro-futurism"`, `"digital-zen"`, `"rustic"`, `"vintage"`, `"shabby-chic"`

- **`prompt`** (`string`, _optional_):
  Additional user instructions for the redesign.

- **`season`** (`string`, _optional_):
  Seasonal atmosphere to influence the overall interior mood and the view treatment when relevant.
  - Default: `"auto"`
  - Options: `"spring"`, `"summer"`, `"autumn"`, `"winter"`, `"auto"`

- **`daylight`** (`string`, _optional_):
  Preferred lighting or time-of-day mood.
  - Default: `"auto"`
  - Options: `"midday"`, `"night"`, `"sunset"`, `"sunrise"`, `"auto"`

- **`file_url`** (`string`, _required_):
  External URL of the uploaded interior space image.

- **`keep_floor`** (`boolean`, _optional_):
  When true, preserve the existing flooring exactly — material, pattern, color, and finish (no restyle). When false, the floor may be restyled to suit the chosen style.
  - Default: `false`

- **`keep_lighting`** (`boolean`, _optional_):
  When true, preserve the existing light fixtures (ceiling lights, pendants, sconces, lamps) in their original positions and styles. When false, fixtures may be replaced or restyled. Does not affect the daylight mood setting.
  - Default: `false`

- **`keep_furniture`** (`boolean`, _optional_):
  When true, keep the room's existing furniture pieces (no swapping or replacement). When false, furniture is restyled or replaced to reflect the chosen style.
  - Default: `false`

- **`keep_wall_color`** (`boolean`, _optional_):
  When true, preserve the existing wall colors, finishes, and textures exactly (no repaint). When false, walls may be repainted or refinished to suit the chosen style.
  - Default: `false`

- **`architectural_material`** (`string`, _optional_):
  Primary architectural or decorative material to emphasize.
  - Default: `"auto"`
  - Options: `"concrete"`, `"steel"`, `"glass"`, `"wood"`, `"stone"`, `"brick"`, `"bamboo"`, `"clay"`, `"gypsum"`, `"plastic"`, `"auto"`

- **`keep_windows_doors_style`** (`boolean`, _optional_):
  When true, also preserve the frame style, material, color, and finish of every window and door. Their position, size, and count are always preserved regardless of this flag; this flag only governs their visual style.
  - Default: `false`

- **`allow_furniture_reposition`** (`boolean`, _optional_):
  Only meaningful when keep_furniture is true. When true, kept furniture may be rearranged into a new layout; when false, furniture stays in its original positions.
  - Default: `false`

### Output Schema

_No `Output` schema properties are available._

## Default Example

**Output**

```json
"QJsXycUAtI8EAVd5aOZbb"
```
## 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/room-redesign \
  --header "Authorization: Key $MODEL_RUNNER_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "file_url": ""
}')

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/room-redesign", {
  input: {
  "file_url": ""
}
});

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

### Python

```python
import asyncio
import modelrunner_ai

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

asyncio.run(main())
```

## Additional Resources

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