Guide

Tools

The five tool slugs, their options and what each one costs.

Five tools are available at launch. Each costs one image per render at the default 2K resolution.

The authoritative list

GET /v1/tools returns every slug your key can call, with its cost. Read it rather than hardcoding this page: a slug outside that list is rejected with invalid_tool, and the marketing names used on roomagen.com are not slugs.

curl https://api.roomagen.com/api/v1/tools -H "X-Api-Key: rmg_live_YOUR_KEY"

Response

200

[
  {
    "slug": "virtual-staging",
    "images_cost": 1
  },
  {
    "slug": "virtual-renovation",
    "images_cost": 1
  },
  {
    "slug": "image-enhancement",
    "images_cost": 1
  },
  {
    "slug": "day-to-dusk",
    "images_cost": 1
  },
  {
    "slug": "item-removal",
    "images_cost": 1
  }
]

Launch tools

Tool	Slug	Images	Options
Virtual staging	`virtual-staging`	1	`style` (required), `roomType`, `mode`, furniture controls — details
Virtual renovation	`virtual-renovation`	1	`style`, `roomType` — details
Image enhancement	`image-enhancement`	1	`intensity` — details
Day to dusk	`day-to-dusk`	1	`timeShift`, `viewType`, `season` — details
Item removal	`item-removal`	1	none; drive it with `tier` and `customPrompt` — details

GET /v1/tools may return more slugs than are documented here; the five above are the supported launch set.

Common options

These keys are accepted by every tool handler, alongside the per-tool options above.

Option	Type	Values	Default	Required	Description
`resolution`	string	`2K4K`	`2K`	optional	4K doubles images_charged.
`tier`	string	`autoguidedcustom`	`guided`	optional	auto ignores the other options and uses the tool's own defaults; guided uses the keys in x-tool-options; custom drives the tool from customPrompt.
`customPrompt`	string	max 500 characters	—	optional	Free-text instruction. Required when tier is custom, ignored otherwise.

resolution: "4K" doubles images_charged.

tier decides where a tool takes its instructions from: auto ignores the other options and uses the tool's own defaults, guided uses the per-tool keys, and custom drives the tool from customPrompt.

Virtual staging does not take the common options

Virtual staging is a multi-step pipeline rather than a tool handler. It always renders at 2K, has no tier or customPrompt path, and rejects any key outside its own list — including resolution, tier and customPrompt — with invalid_request. Sending them is an error, not a no-op. It is also the one tool with a required option: style.

For every other tool, an unknown key is ignored, while an out-of-range value for a key the tool does know is rejected with invalid_request.

Next step

Webhooks — get results pushed to you instead of polling.