Pixly

AI 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.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "style": {
      "type": "string",
      "minLength": 1,
      "description": "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.",
      "examples": [
        "modern-minimal",
        "scandinavian",
        "industrial",
        "mid-century-modern",
        "japandi"
      ]
    },
    "roomType": {
      "description": "Room type hint; omit to let vision infer it from the photo",
      "type": "string"
    },
    "customInstructions": {
      "description": "Optional extra instructions blended into the staging prompt",
      "type": "string"
    },
    "numImages": {
      "default": 1,
      "description": "Ignored — staging always returns one image. Call again for another take.",
      "deprecated": true,
      "type": "integer",
      "minimum": 1,
      "maximum": 4
    },
    "stagingQuality": {
      "description": "Ignored — the Pro tier is retired. Every staging costs 1 credit and may render a second version on another model for free.",
      "deprecated": true,
      "type": "string",
      "enum": [
        "standard",
        "pro"
      ]
    }
  },
  "required": [
    "style"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Apply a specific change to a previously staged photo (swap the sofa, add a rug) while preserving everything else. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "description": "URL of the PREVIOUS staged result to edit (the resultUrls entry from its job). Either imageUrl or r2Path is required.",
      "type": "string",
      "minLength": 1
    },
    "r2Path": {
      "description": "R2 path of the previous staged result — the alternative to imageUrl.",
      "type": "string",
      "minLength": 1
    },
    "style": {
      "type": "string",
      "minLength": 1,
      "description": "Style id of the staging being edited (the same ids virtual_staging takes), used as context to match new elements"
    },
    "customInstructions": {
      "type": "string",
      "minLength": 1,
      "description": "The concrete edit to apply, e.g. \"change the sofa to grey\""
    },
    "sourceJobId": {
      "description": "Job the edited result came from (lineage)",
      "type": "string"
    },
    "sourceResultIndex": {
      "description": "Which variation was edited",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "style",
    "customInstructions"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Photo to video: turn a single listing photo into a short cinematic real estate video with a professional camera move (zoom, orbit, fly-through, crane up…). No second frame needed. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "cameraMove": {
      "default": "zoom",
      "description": "Camera-move preset",
      "type": "string",
      "enum": [
        "zoom",
        "fly-through",
        "orbit",
        "pan",
        "aerial",
        "pull-back",
        "crane-up",
        "tilt-up",
        "boom-down",
        "drone-orbit",
        "flyover",
        "pull-away",
        "handheld"
      ]
    },
    "direction": {
      "description": "The direction the camera travels, for the moves that have one (orbit, pan, drone-orbit). 'left-to-right' sends the camera rightward, 'right-to-left' leftward. Ignored by every other move; omit to use the move's own default.",
      "type": "string",
      "enum": [
        "left-to-right",
        "right-to-left"
      ]
    },
    "durationSeconds": {
      "default": 5,
      "description": "Clip length; the routed model validates its supported tiers",
      "anyOf": [
        {
          "type": "number",
          "const": 5
        },
        {
          "type": "number",
          "const": 10
        }
      ]
    },
    "format": {
      "default": "9:16",
      "description": "Aspect ratio",
      "type": "string",
      "enum": [
        "9:16",
        "16:9"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Turn a start photo — and optionally an end photo — into a video. With an end photo the camera travels from the first photo and lands exactly on the second (e.g. two views of the same kitchen → an orbit around the island). Pick a ready-made camera move or write your own prompt; choose the model, length and sound. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "description": "Start frame — where the video begins. Public https URL or data: URI; either imageUrl or r2Path is required.",
      "type": "string",
      "minLength": 1
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "endImageUrl": {
      "description": "Optional end frame — the camera travels from the start photo and lands exactly on this one. Best when both photos show the same space from different spots.",
      "type": "string",
      "minLength": 1
    },
    "endR2Path": {
      "description": "R2 path of the end frame — the alternative to endImageUrl.",
      "type": "string",
      "minLength": 1
    },
    "cameraMove": {
      "default": "smooth",
      "description": "Ready-made camera move used when no prompt is given.",
      "type": "string",
      "enum": [
        "smooth",
        "walk",
        "orbitLeft",
        "orbitRight",
        "pushIn",
        "pullBack",
        "riseUp"
      ]
    },
    "prompt": {
      "description": "Your own description of the video, in any language. Replaces cameraMove when set.",
      "type": "string",
      "maxLength": 1000
    },
    "model": {
      "default": "kling-v3",
      "description": "kling-v3: 3/5/8/10/15 s, optional sound, lands most precisely on the end frame. kling-2.6: 5/10 s, silent, cheaper.",
      "type": "string",
      "enum": [
        "kling-v3",
        "kling-2.6"
      ]
    },
    "durationSeconds": {
      "default": 5,
      "description": "Clip length. kling-v3 takes 3, 5, 8, 10 or 15; kling-2.6 takes 5 or 10.",
      "type": "integer",
      "minimum": 3,
      "maximum": 15
    },
    "sound": {
      "default": false,
      "description": "Add ambient sound (kling-v3 only; kling-2.6 is always silent).",
      "type": "boolean"
    },
    "format": {
      "default": "16:9",
      "description": "Label for the clip's shape; the video follows the start photo's own shape.",
      "type": "string",
      "enum": [
        "16:9",
        "9:16",
        "1:1"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Before and after video: animate a before→after transformation (e.g. empty room → staged, or a renovation) into a social-ready reveal reel from two photos. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "beforeImageUrl": {
      "description": "Start frame (e.g. the empty room photo) — https URL or data: URI",
      "type": "string",
      "minLength": 1
    },
    "afterImageUrl": {
      "description": "End frame (e.g. the staged result) — https URL or data: URI",
      "type": "string",
      "minLength": 1
    },
    "beforeR2Path": {
      "description": "R2 path of the start frame — the alternative to beforeImageUrl.",
      "type": "string",
      "minLength": 1
    },
    "afterR2Path": {
      "description": "R2 path of the end frame — the alternative to afterImageUrl.",
      "type": "string",
      "minLength": 1
    },
    "videoIntent": {
      "default": "staging_reveal",
      "type": "string",
      "enum": [
        "staging_reveal",
        "staging_reveal_reverse",
        "construction_timelapse"
      ]
    },
    "revealStyle": {
      "default": "smooth",
      "description": "How the transformation is revealed",
      "type": "string",
      "enum": [
        "smooth",
        "slideIn",
        "dropLand",
        "glowBuild",
        "movers"
      ]
    },
    "durationSeconds": {
      "default": 5,
      "anyOf": [
        {
          "type": "number",
          "const": 5
        },
        {
          "type": "number",
          "const": 10
        }
      ]
    },
    "format": {
      "default": "9:16",
      "type": "string",
      "enum": [
        "9:16",
        "16:9",
        "1:1"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Real estate photo editing in one step: turn an amateur listing photo into a finished, professional photo (exposure, color, clarity). Returns 3 variants to pick from. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Remove clutter, mess, and personal items from a listing photo while keeping the room, furniture, and architecture intact. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Remove furniture from a photo: empty a room and rebuild the surfaces behind what was taken out, keeping the architecture and camera angle identical — the blank canvas for restaging. By default it also removes the room's own joinery (fitted kitchen, built-in wardrobes, bathroom fixtures); mode 'movable' leaves those alone, and an optional extra takes the floor covering out too, for a full renovation strip-back. Doors always stay. (Declutter is the opposite: it keeps the furniture.) Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "mode": {
      "description": "How far to strip the room. 'fitted' (the default) removes the movable contents AND the room's own joinery — the fitted kitchen and its appliances, built-in wardrobes and shelving, and bathroom sanitaryware. 'movable' removes only furniture, rugs, curtains, art, plants and lamps, leaving the kitchen, built-ins, sanitaryware, floor and doors exactly as they are.",
      "type": "string",
      "enum": [
        "movable",
        "fitted"
      ]
    },
    "extras": {
      "description": "Extra things to take out, for a full strip-back. Only applies with mode 'fitted' and is ignored otherwise: 'floor' takes the floor covering down to bare concrete screed. Omit to keep the floor. Doors always stay, as do walls, ceiling, windows, structural openings and the camera.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "floor"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Day to dusk (virtual twilight): turn a daytime listing photo into a magazine-style evening scene — lights on, warm glow, dusk sky — with the building and camera angle unchanged. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Replace a grey, overcast or blown-out sky in an exterior listing photo with a natural clear blue sky, matching the light and keeping the building, trees and reflections unchanged. A run takes about 1–2 minutes; poll get_job until it completes. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "sky": {
      "default": "auto",
      "description": "Sky style. 'auto' lets the tool pick what suits the photo's light.",
      "type": "string",
      "enum": [
        "auto",
        "clear",
        "light_clouds",
        "dramatic_clouds",
        "sunset",
        "pastel_sunrise",
        "winter_clear"
      ]
    },
    "sun": {
      "default": "auto",
      "description": "Sun glow: auto (a glow for sunset/sunrise styles, none otherwise), on (place it with sunX/sunY), off.",
      "type": "string",
      "enum": [
        "auto",
        "on",
        "off"
      ]
    },
    "sunX": {
      "description": "With sun=on: glow position from the left edge, 0..1.",
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "sunY": {
      "description": "With sun=on: glow position from the top edge, 0..1 (kept in the top 60%).",
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Turn patchy, brown or bare grass in an exterior listing photo into a healthy green lawn, leaving driveways, paths, beds and the house untouched. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "lawn": {
      "default": "auto",
      "description": "Lawn style. 'auto' lets the tool pick a healthy lawn that suits the photo.",
      "type": "string",
      "enum": [
        "auto",
        "fresh_mown",
        "lush",
        "natural",
        "golf",
        "warm_season"
      ]
    },
    "shade": {
      "default": "medium",
      "description": "How green; only used with a chosen lawn style.",
      "type": "string",
      "enum": [
        "light",
        "medium",
        "deep"
      ]
    },
    "stripes": {
      "default": "auto",
      "description": "Mowing stripes: auto (stripes for fresh_mown and golf, none otherwise), on, off.",
      "type": "string",
      "enum": [
        "auto",
        "on",
        "off"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Give one or more surfaces of a room a new finish — repaint the walls, change the floor, reface the kitchen cabinets and worktop, retile the bathroom or refinish the furniture — while the room's layout, fittings, windows and camera angle stay exactly as shot. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "surfaces": {
      "description": "Which surfaces get a new finish: 'walls', 'floor', 'cabinets' (fitted joinery plus its worktop and splashback), 'bathroom_tiles' or 'furniture' (upholstery and wood finishes). Omit for walls. The room's layout, fittings and camera never change.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "walls",
          "floor",
          "cabinets",
          "bathroom_tiles",
          "furniture"
        ]
      }
    },
    "looks": {
      "description": "The finish per surface: 'auto', one of the presets below, or 'custom' with your own words in `notes`. A finish that does not belong to its surface falls back to 'auto' (the tool picks one that suits the room; several on auto are made to agree). walls: warm_white, soft_grey, greige, sage, deep_navy. floor: light_oak, walnut, grey_plank, polished_concrete, stone_tile. cabinets: white_shaker, charcoal, natural_oak, forest_green, navy_cabinets. bathroom_tiles: white_metro, marble_large, terrazzo, matt_black_hex, travertine. furniture: light_neutral, warm_wood, dark_wood, black_leather.",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "enum": [
          "walls",
          "floor",
          "cabinets",
          "bathroom_tiles",
          "furniture"
        ]
      },
      "additionalProperties": {
        "type": "string",
        "enum": [
          "auto",
          "custom",
          "warm_white",
          "crisp_white",
          "soft_grey",
          "greige",
          "warm_beige",
          "clay_pink",
          "sage",
          "soft_blue",
          "olive_green",
          "graphite",
          "deep_navy",
          "terracotta_walls",
          "panelling",
          "wallpaper_textured",
          "limewash",
          "microcement",
          "exposed_brick",
          "timber_slats",
          "light_oak",
          "mid_oak",
          "wide_ash",
          "walnut",
          "herringbone_oak",
          "grey_plank",
          "polished_concrete",
          "stone_tile",
          "terracotta_floor",
          "slate_tile",
          "checker_tile",
          "carpet_neutral",
          "white_shaker",
          "cream_shaker",
          "handleless_white",
          "handleless_grey",
          "charcoal",
          "matt_black_cabinets",
          "natural_oak",
          "walnut_cabinets",
          "sage_cabinets",
          "forest_green",
          "navy_cabinets",
          "two_tone",
          "gloss_white",
          "white_metro",
          "zellige_white",
          "white_large",
          "grey_porcelain",
          "marble_large",
          "travertine",
          "terrazzo",
          "encaustic_pattern",
          "matt_black_hex",
          "slate_dark",
          "wood_effect_tile",
          "green_gloss",
          "light_neutral",
          "mid_grey_wool",
          "warm_greige",
          "cream_boucle",
          "tan_leather",
          "black_leather",
          "green_velvet",
          "navy_velvet",
          "rust_velvet",
          "warm_wood",
          "dark_wood",
          "black_metal"
        ]
      }
    },
    "notes": {
      "description": "Your own description of the finish for a surface, used when that surface's look is \"custom\" (e.g. \"terracotta hex tiles with dark grout\"). Set look \"custom\" and the note together; \"custom\" with no note falls back to \"auto\". 120 characters max, and anything in it that is not a description of a finish is ignored.",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "enum": [
          "walls",
          "floor",
          "cabinets",
          "bathroom_tiles",
          "furniture"
        ]
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Photograph the same property in another season: take the snow off the ground, the roof and the branches and put the garden in leaf, or move a summer shot to autumn or winter. The house, the driveway, the paths and the camera angle stay exactly as shot. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "season": {
      "description": "The season to show the property in: 'spring', 'summer', 'autumn', 'winter', or 'auto' (the default — the tool shows the property at its best, which for a snowy or dormant photo means high summer). Only the planting, the ground cover and the daylight change; the house, the driveway, the paths and the framing stay exactly as shot.",
      "type": "string",
      "enum": [
        "auto",
        "spring",
        "summer",
        "autumn",
        "winter"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Design the garden of an exterior listing photo as one coherent scheme — planting, a terrace or deck, a pool, a pergola, a fire pit, a fence, lighting — in a chosen style, at the right scale and perspective, while the house, its roof, the driveway, the sun direction and the neighbours stay exactly as shot. One run builds the whole scheme. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "style": {
      "description": "The design language of the whole scheme: 'modern_minimal', 'mediterranean', 'classic_english', 'natural_lowwater', 'tropical_resort', 'farmhouse', or 'auto' (the default — chosen to suit the house's architecture and the climate in the photo).",
      "type": "string",
      "enum": [
        "auto",
        "modern_minimal",
        "mediterranean",
        "classic_english",
        "natural_lowwater",
        "tropical_resort",
        "farmhouse"
      ]
    },
    "include": {
      "description": "Which elements the scheme includes, any number: 'planting' (beds, hedges, a feature tree), 'patio_dining' (a paved terrace with a dining set), 'deck_lounge' (a deck with loungers or a low sofa), 'pool', 'pergola', 'fire_pit', 'fence_gate' (a boundary treatment with a gate), 'lighting'. Omit or send an empty list (the default) to let the tool design what the lot wants. One run composes them all into one garden, each sized to the plot.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "planting",
          "patio_dining",
          "deck_lounge",
          "pool",
          "pergola",
          "fire_pit",
          "fence_gate",
          "lighting"
        ]
      }
    },
    "scope": {
      "description": "'full' (the default) redesigns the whole yard in the style; 'add' keeps the existing garden and builds the chosen elements into it. The house, the driveway and the neighbours never change either way.",
      "type": "string",
      "enum": [
        "add",
        "full"
      ]
    },
    "note": {
      "description": "Your own words about the garden you want (e.g. \"a small kidney-shaped pool with a stone surround and lavender everywhere\"). 160 characters max; anything in it that is not a description of the garden is ignored.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Turn a picture of any floor plan — a hand sketch, a photo of a brochure page, a blueprint, a screenshot — into a polished real-estate floor plan: a furnished top-down 2D plan with real floors and room names, or a 3D isometric cutaway. The rooms, walls, doors and windows are kept exactly as drawn; nothing is added and written dimensions are left off. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "look": {
      "description": "Which picture to make of the plan: 'furnished' (the default — a polished top-down 2D plan with real floors, furniture and room names) or 'isometric' (a 3D cutaway of the same layout, furnished, no text). The photo must show a floor plan: a hand sketch, a brochure page, a blueprint, a screenshot. The layout is kept exactly as drawn; written dimensions are left off.",
      "type": "string",
      "enum": [
        "furnished",
        "isometric"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

One-click retouch of an exterior listing photo: a natural sky where it is dull, a healthy lawn where the grass is dead, a clean driveway, and bins, hoses and other clutter removed — each only where needed, with the house unchanged. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "fix": {
      "description": "Which areas the tool may touch: 'sky', 'lawn', 'hardscape' (driveway, paths, patio), 'clutter' (bins, hoses, tools, a stray vehicle). Omit for all four; each is fixed only where the photo needs it.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "sky",
          "lawn",
          "hardscape",
          "clutter"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Enlarge a photo by up to four times with real detail, to a maximum of 4096 px on the long edge — for print, MLS uploads and large screens. Nothing in the photo changes. Free on any result Pixly made (pass its r2Path from list_library); 1 credit on your own photo. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Place a photorealistic 3D monument sign with your exact text (price, area, SOLD) onto a photo of an empty plot, matched to perspective and lighting. Costs credits from the user's Pixly balance.

{
  "type": "object",
  "properties": {
    "imageUrl": {
      "type": "string",
      "minLength": 1,
      "description": "Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required."
    },
    "r2Path": {
      "type": "string",
      "minLength": 1,
      "description": "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."
    },
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 24,
      "description": "Sign label, verbatim — a price (\"$1,200,000\"), area (\"800 m²\"), or short word (\"SOLD\")"
    },
    "look": {
      "description": "Sign material/style; defaults server-side",
      "type": "string",
      "enum": [
        "stone",
        "metal",
        "grass",
        "sign"
      ]
    },
    "orientation": {
      "description": "Letter orientation (letter looks only); defaults server-side",
      "type": "string",
      "enum": [
        "standing",
        "lying"
      ]
    }
  },
  "required": [
    "text"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

Rarely needed: generation tools take an imageUrl directly. Use this only to import a photo into Pixly ahead of time, e.g. to reuse one URL across several tools without refetching it each time.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Publicly reachable image URL (JPG/PNG/WebP, max 10 MB) to import into Pixly"
    }
  },
  "required": [
    "url"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Get a presigned upload URL for a LOCAL image file — the one case a URL can't cover. PUT the file to uploadUrl with the same Content-Type, then pass the returned r2Path to a generation tool instead of imageUrl. Ticket expires in 1 hour.

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Original filename, used for the extension"
    },
    "contentType": {
      "type": "string",
      "enum": [
        "image/jpeg",
        "image/png",
        "image/webp",
        "image/heic",
        "image/heif",
        "image/tiff"
      ],
      "description": "MIME type the PUT request will send"
    },
    "sizeBytes": {
      "description": "Exact byte size of the file. Recommended: when given it is signed into the URL, so the upload is bounded server-side.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 10485760
    }
  },
  "required": [
    "filename",
    "contentType"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Check a generation job's status and fetch result URLs when it's done. Video jobs take 1-5 minutes — poll this with a few seconds between calls.

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "minLength": 1,
      "description": "Job id returned by a generation tool"
    }
  },
  "required": [
    "jobId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "jobId": {
      "type": "string",
      "description": "Pass to get_job to poll"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "description": "pending | processing | completed | failed — anything not completed/failed is still running"
    },
    "creditsCharged": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "completedAt": {
      "type": "string"
    },
    "resultUrls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Present when completed; valid 7 days"
    },
    "error": {
      "type": "string"
    },
    "note": {
      "type": "string"
    }
  },
  "required": [
    "jobId",
    "status"
  ]
}

List the user's recent generations, or with type "uploads" their own uploaded source photos, newest first. Uploads are the way in when the photo is a local file: connectors cannot send bytes, so the user adds it at https://pixly.app/app and you pick up the r2Path here.

{
  "type": "object",
  "properties": {
    "type": {
      "description": "Filter by media type. \"uploads\" lists the user's own source photos instead of generations — use it when they refer to a photo they added but have not run a tool on yet.",
      "type": "string",
      "enum": [
        "images",
        "videos",
        "uploads"
      ]
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The user's current Pixly credit balance and plan.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Use when a tool fails for lack of credits or a plan. Returns a Stripe Checkout URL for the user to pay on — this never charges anything by itself, and you cannot pay for them. With no active plan it is a subscription (plans: starter (Starter: $5.99/week, 20 credits); agent (Agent: $19.99/month, 100 credits); pro_agent (Pro Agent: $49.99/month, 300 credits); team (Team: $149.99/month, 1000 credits)); with a plan it is a one-time credit top-up. After they pay, credits arrive in seconds: check get_credit_balance, then run the tool again.

{
  "type": "object",
  "properties": {
    "plan": {
      "description": "Plan to subscribe to, for an account with no active plan. Defaults to \"starter\". Ignored for a top-up.",
      "type": "string",
      "enum": [
        "starter",
        "agent",
        "pro_agent",
        "team"
      ]
    },
    "topUpUsd": {
      "description": "For an account that already has a plan: one-time credit top-up amount in USD (10–500, default 10), priced at that plan's rate.",
      "type": "number",
      "minimum": 10,
      "maximum": 500
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}