Virtual Staging
virtual_stagingAI virtual staging: furnish and style an empty (or badly furnished) room photo in a chosen interior design style — also the tool for "redesign this room" or "show this room in another style". HD, watermark-free results. Some stagings also render a free second version: get_job then lists both under versions (the second can take a minute or two longer) — show the user both and let them pick. Costs credits from the user's Pixly balance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| style | Yes | Interior style id. One of: modern-minimal, scandinavian, industrial, mid-century-modern, japandi, contemporary, transitional, urban-chic, bauhaus, organic-modern, brutalist, traditional, art-deco, colonial, victorian, french-country, english-cottage, neoclassical, art-nouveau, grandmillennial, hollywood-regency, mediterranean, mediterranean-modern, rustic-farmhouse, bohemian, tropical, family-staging, hygge, wabi-sabi, modern-farmhouse, cottagecore, shabby-chic, cabin-lodge, eclectic, warm-luxury, investor-premium, contemporary-dark, glam, penthouse-modern, hotel-suite, maximalist, coastal, desert-modern, hacienda, pacific-northwest, caribbean-resort, hamptons, moroccan, tuscan, southwestern, asian-zen, coastal-grandmother, cape-cod. When the user has no preference, "modern-minimal" or "scandinavian" suit most listings. | |
| r2Path | No | Storage path of a photo already in the user's Pixly library (from list_library, or returned by an upload ticket) — the alternative to imageUrl. | |
| imageUrl | No | Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required. | |
| roomType | No | Room type hint; omit to let vision infer it from the photo | |
| numImages | No | Ignored — staging always returns one image. Call again for another take. | |
| stagingQuality | No | Ignored — the Pro tier is retired. Every staging costs 1 credit and may render a second version on another model for free. | |
| customInstructions | No | Optional extra instructions blended into the staging prompt |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| type | No | ||
| error | No | ||
| jobId | Yes | Pass to get_job to poll | |
| status | Yes | pending | processing | completed | failed — anything not completed/failed is still running | |
| createdAt | No | ||
| resultUrls | No | Present when completed; valid 7 days | |
| completedAt | No | ||
| creditsCharged | No |