Guide
Tools
Every tool the API accepts, what each one costs, and the options all tools share.
Every job names one tool. The tables below list every tool the API accepts, grouped by what it
does, with the slug to send, what a render costs and whether the tool reads customPrompt. Each
row links to the page with its options and an example.
The authoritative list
GET /v1/tools returns every slug your key can call, with its cost. Every slug it returns is
documented on 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"[
{
"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
}
]The example above is shortened; the tables below are the full list. images_cost is the price of
one render at the default 2K resolution, and resolution: "4K" doubles it.
Staging and furniture
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Virtual staging Furnishes an empty room in a chosen style, restyles a furnished one, or rebuilds it as another room type. | virtual-staging | 1 | not read |
| Empty your space Takes the furniture and belongings out of a room, kitchen, bathroom, utility, outdoor or commercial space. | empty-your-space | 1 | not read |
| Empty your space (advanced) Empties the room and can also strip wallpaper, panelling and floor coverings. | empty-your-space-advanced | 1 | not read |
| Add furniture object Adds one piece of furniture, named by type and style or described in your own words. | add-furniture-object | 1 | not read |
| Furniture replacement Replaces every piece of furniture with a coordinated set in one style. | furniture-replacement | 1 | not read |
| Furniture facelift Recolours, re-upholsters or refinishes the most prominent piece of furniture. | furniture-facelift | 1 | not read |
Interior renovation
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Virtual renovation Restyles the finishes and fixtures of a room in a chosen style, keeping its layout. | virtual-renovation | 1 | read |
| Wall color change Repaints every visible wall in a hex colour and paint finish. | wall-color-change | 1 | not read |
| Wall treatment Paint, wallpaper, stone cladding, brick, wood panelling or tile on the walls. | wall-treatment | 1 | read |
| Flooring replacement Swaps the floor for hardwood, tile, carpet, vinyl, marble, laminate or concrete; rugs stay. | flooring-replacement | 1 | read |
| Restyle surfaces Gives one surface — countertop, backsplash, wall tile or floor — a new material. | restyle-surfaces | 1 | read |
| Fireplace renovation Redesigns the fireplace, its firebox and its surround. | fireplace-renovation | 1 | read |
| Staircase railing Replaces the stair railing with a new type and finish. | staircase-railing | 1 | read |
| Ceiling fan Adds or replaces a ceiling fan. | ceiling-fan | 1 | read |
| Lighting update Replaces the light fixtures in the photo — pendants, recessed lights, chandeliers, sconces and more. | lighting-update | 1 | read |
| Door update Changes the style and finish of interior, front, closet, French, barn or sliding doors. | door-update | 1 | read |
| Construction interior Shows a raw, under-construction room finished and furnished, in the same geometry. | construction-interior | 1 | not read |
Kitchen and bath
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Cabinet replacement New cabinet doors in a chosen style and colour. | cabinet-replacement | 1 | read |
| Countertop replacement Swaps the countertops for granite, quartz, marble, butcher block and more. | countertop-replacement | 1 | read |
| Backsplash update Replaces the kitchen backsplash. | backsplash-update | 1 | read |
| Kitchen fixtures Replaces the faucet, sink, range hood or disposal unit. | kitchen-fixtures | 1 | read |
| Bathroom fixtures Replaces the faucet, sink, shower, bathtub, toilet or towel bar. | bathroom-fixtures | 1 | read |
| Bathroom tile Retiles the shower, the tub surround, the floor or the whole bathroom. | bathroom-tile | 1 | read |
Photo editing
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Image enhancement Corrects exposure, white balance and clarity on a property photo. | image-enhancement | 1 | read |
| HDR enhancement Opens shadows and recovers highlights, as if merged from bracketed exposures. | hdr-enhancement | 1 | not read |
| Color correction Removes colour casts and sets a neutral white balance. | color-correction | 1 | not read |
| Lighting adjustment Relights the photo in a chosen mood without changing anything in it. | lighting-adjustment | 1 | not read |
| Noise reduction Removes grain and colour speckles from a low-light photo, keeping real detail. | noise-reduction | 1 | not read |
| Lens correction Straightens lines a lens bent, removes colour fringes and evens out dark corners. | lens-correction | 1 | not read |
| Perspective correction Makes verticals upright and horizontals level, as if shot from a levelled tripod. | perspective-correction | 1 | not read |
| Image upscaling Re-renders the photo at 4K with sharper detail; never smaller than the input. | image-upscaling | 1 | not read |
| 4K upscale The same prompt and 4K output as image-upscaling, charged as two images. | 4k-upscale | 2 | not read |
| Sky replacement Replaces the sky and matches the light on the property to it. | sky-replacement | 1 | not read |
| Window view replacement Replaces what is seen through the windows of an interior. | window-view-replacement | 1 | not read |
| Background replacement Replaces the surroundings of a building, which stays as photographed. | background-replacement | 1 | not read |
| Aerial photo editing Clears haze and balances colour and detail on a drone photo. | aerial-photo-editing | 1 | not read |
| Portrait retouching Retouches a headshot — skin, tone, lighting, background — without changing features. | portrait-retouching | 1 | not read |
| Property highlight A subtle listing-grade pass on light, finishes and the window view. | property-highlight | 1 | not read |
Light and seasons
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Day to dusk (interior) Relights a daytime photo of a room as a dusk, evening or night shot. | day-to-dusk | 1 | read |
| Day to dusk (exterior) Relights a daytime photo of a building's exterior for the hour you pick. | day-to-dusk-exterior | 1 | read |
| Seasonal changes Shows the scene in spring, summer, autumn or winter. | seasonal-changes | 1 | not read |
| Festive flip Adds tasteful decorations for a holiday or a seasonal theme. | festive-flip | 1 | not read |
Removal and restoration
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Item removal Removes clutter, furniture or a named object and rebuilds what was behind it. | item-removal | 1 | read |
| Declutter Removes loose clutter and personal items; furniture and fixtures stay. | declutter | 1 | not read |
| Watermark removal Finds and removes watermarks, text overlays or people across the whole photo. | watermark-removal | 1 | not read |
| Fire restoration Shows a fire-damaged space after professional restoration. | fire-restoration | 1 | not read |
| Water damage restoration Shows a water-damaged space after professional restoration. | water-damage-restoration | 1 | not read |
Exterior and outdoor
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Exterior renovation Renovates the facade, trim, doors, windows and lighting in one style. | exterior-renovation | 1 | not read |
| Construction exterior Shows an unfinished building with its facade, roof and surroundings completed. | construction-exterior | 1 | not read |
| Roof replacement A new roof on the existing roof lines. | roof-replacement | 1 | not read |
| Driveway renovation A new driveway surface on the existing footprint. | driveway-renovation | 1 | not read |
| Fence addition Adds a fence along the visible boundaries. | fence-addition | 1 | not read |
| Exterior additions Adds a fence or wall, a driveway or path, or a building such as a garage or shed. | exterior-additions | 1 | not read |
| Garage renovation Turns a garage into storage, a workshop, a home gym or a studio. | garage-renovation | 1 | not read |
| Patio design Designs an outdoor lounge, dining, fire-pit or garden space. | patio-design | 1 | not read |
| Outdoor living Adds a pergola, gazebo, deck, outdoor kitchen, fire pit, hot tub, sunroom and more. | outdoor-living | 1 | not read |
| Landscaping Professional landscaping in a chosen style. | landscaping | 1 | not read |
| Lawn enhancement Makes the lawn green, even and freshly mowed. | lawn-enhancement | 1 | not read |
| Pool Adds a pool, restyles the existing one, or removes it. | pool | 1 | not read |
| Pool addition Adds a pool with a deck surround. | pool-addition | 1 | not read |
| Pool removal Removes the pool and fills the space with lawn, patio or garden. | pool-removal | 1 | not read |
Floor plans
| Tool | Slug | Images | customPrompt |
|---|---|---|---|
| Floor plan to 3D Turns a 2D floor plan into a 3D cutaway or top-down render. | floor-plan-to-3d | 1 | read |
| Sketch to floor plan Redraws a hand sketch, scan or photo of a plan as a clean 2D floor plan. | sketch-to-floor-plan | 1 | not read |
| Floor plan colorize Colours in a black-and-white 2D plan in a listing palette. | floor-plan-colorize | 1 | not read |
| Floor plan visualize Renders a 2D plan as a furnished top-down marketing image. | floor-plan-visualize | 1 | not read |
Common options
These keys are accepted by every tool handler, alongside the per-tool options.
| Option | Type | Values | Default | Required | Description |
|---|---|---|---|---|---|
resolution | string | 2K4K | 2K | optional | 4K doubles images_charged. Any other value is ignored (named in warnings) and the default size is used. |
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. Only tools that take a custom prompt read it — each tool's page says whether it does; elsewhere it is ignored, and named in warnings. |
tier decides how a tool reads its input:
guided(the default) checks each option against the values its page lists — a value the tool does not know is rejected withinvalid_request— and renders from the options. Use it unless you have a reason not to.customrequirescustomPromptand renders from your text instead of the options, without checking them. Only the tools marked read in the tables above take a custom prompt; on the others the text is ignored, the options are used unchecked, and the response'swarningssays so.autoskips the checks too. Tools with a built-in preset — the floor plan tools, the kitchen and bath tools and most interior renovation tools — use that preset instead of your options (sketch to floor plan still takes itspageSize); the others render from your options asguideddoes, unchecked.
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 — and named in the response's
warnings — while an out-of-range value for a key the tool does know is
rejected with invalid_request in the guided tier.
Next step
Webhooks — get results pushed to you instead of polling.