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. Costs credits from the user's Pixly balance.
Input Schema
TableJSON 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, italian-modern, traditional, art-deco, colonial, victorian, french-country, english-cottage, neoclassical, art-nouveau, grandmillennial, hollywood-regency, parisian-chic, modern-classic, craftsman, mediterranean, mediterranean-modern, rustic-farmhouse, bohemian, tropical, family-staging, hygge, wabi-sabi, modern-farmhouse, cottagecore, shabby-chic, cabin-lodge, eclectic, retro-70s, warm-luxury, investor-premium, contemporary-dark, glam, penthouse-modern, hotel-suite, maximalist, quiet-luxury, coastal, desert-modern, hacienda, pacific-northwest, caribbean-resort, hamptons, moroccan, tuscan, southwestern, asian-zen, coastal-grandmother, cape-cod, california-casual, mountain-modern. 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 | |
| listingId | No | A property folder (from list_listings or create_listing) to put the result in. Results of a photo that is already in a folder go there by themselves. | |
| 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. | |
| customInstructions | No | Optional: ONLY a wish the user stated beyond the style and room, in their words (e.g. "add a reading chair", "no rug"). Leave it out otherwise — Pixly writes the staging prompt itself (keeps walls, windows and camera angle, furnishes to scale); never restate the request or list furniture here. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobs | No | Several jobs at once (get_job with jobIds, or a plan's steps): each one's jobId, status and results | |
| note | No | ||
| type | No | ||
| error | No | ||
| jobId | Yes | Pass to get_job to poll | |
| quote | No | Present when status is "awaiting_confirmation": nothing ran and nothing was charged yet — the price and settings the user is asked to confirm | |
| 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 | ||
| resultPaths | No | Storage path of each result — pass one as r2Path (or beforeR2Path, a photos[] item) to run another tool on this result | |
| creditsCharged | No |