Pixly Developer Docs

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. Costs credits from the user's Pixly balance.

curl -X POST https://pixly.app/api/v1/tools/virtual_staging \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg","style":"..."}'

Change one thing in a photo and keep everything else exactly as it is — the parts the edit doesn't touch are copied from the photo, not redrawn. Works on any photo: a staged room, any Pixly result, or the user's own picture (swap the sofa, recolour a wall, remove a car, change the words on a sign). Optional `mask` limits the change to a marked area. Costs credits from the user's Pixly balance.

curl -X POST https://pixly.app/api/v1/tools/edit_staged_photo \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg","customInstructions":"..."}'

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.

curl -X POST https://pixly.app/api/v1/tools/cinematic_motion \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/photo_to_video \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg","endImageUrl":"https://example.com/room.jpg"}'

Before and after video: animate a before→after transformation (e.g. empty room → staged, or a renovation, or a daylight photo → its Day to Night version with videoIntent day_to_night) into a social-ready reveal reel from two photos. Both photos are required. Only have one? Make the other first with a photo tool — virtual_staging (empty room → furnished), remove_furniture (furnished → empty), day_to_night, restyle_room, makeover_exterior and the other edit tools — and pass its result as afterImageUrl (or beforeImageUrl). Costs credits from the user's Pixly balance.

curl -X POST https://pixly.app/api/v1/tools/before_after_reel \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"beforeImageUrl":"https://example.com/room.jpg","afterImageUrl":"https://example.com/room.jpg"}'

Flythrough video: one continuous camera move through a home from 2-4 room photos in walking order. Each pair of neighbouring photos becomes a 3-second move that flies from one room into the next, and the moves are stitched into one film with a cinematic speed ramp. Returns one job: poll get_job until the film is ready (a few minutes). Costs credits from the user's Pixly balance.

curl -X POST https://pixly.app/api/v1/tools/flythrough_video \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"photos":"..."}'

Free (no credits): one comparison image from a before and an after photo of the same place — e.g. an empty room and its virtual staging, a daylight shot and its dusk version, a room before and after a restyle. Side by side, stacked, or split by a line; original shape, square, 4:5 or 9:16. Write the labels in the user's language. Returns a finished image at once.

curl -X POST https://pixly.app/api/v1/tools/before_after_image \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"beforeImageUrl":"https://example.com/room.jpg","afterImageUrl":"https://example.com/room.jpg"}'

Free (no credits): put the agent's or agency's mark on listing photos — text (name, phone) and/or the logo saved on their Pixly account — in a corner or the middle, up to 10 photos per call. Returns every marked photo at once.

curl -X POST https://pixly.app/api/v1/tools/watermark_photos \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"photos":"..."}'

Free (no credits): find and blur people's faces and car licence plates in property photos before they're posted — street and exterior shots, open houses. Automatic detection, 1–5 photos per call. Says so when nothing is found.

curl -X POST https://pixly.app/api/v1/tools/blur_faces_plates \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"photos":"..."}'

Free (no credits): automatically straighten a property photo — leaning walls made vertical (converging verticals from a tilted camera) and a tilted horizon levelled, like a pro photographer's lens correction. Crops the edges slightly. Best before staging or any other edit. Says so when the photo is already straight or has no straight lines to go by.

curl -X POST https://pixly.app/api/v1/tools/straighten_photo \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

Free (no credits): draw a clean 2D floor plan from a layout YOU write — read the user's description, or look at their hand sketch or brochure plan, and send every room as a rectangle in metres (or feet) plus doors and windows. Returns the drawn plan (areas and dimensions on it) at once, saved so the user can fine-tune it in Pixly's floor plan editor. If the layout has problems (overlapping rooms, a door between rooms that don't touch) you get exactly what to fix — fix it and call again. To change a plan, call again with its planId and the whole updated layout; the new version is saved as its own plan and the earlier one is kept.

curl -X POST https://pixly.app/api/v1/tools/draw_floor_plan \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"rooms":"..."}'

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.

curl -X POST https://pixly.app/api/v1/tools/enhance_photo \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/declutter_photo \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/remove_furniture \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/day_to_night \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/replace_sky \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/replace_lawn \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/restyle_room \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/reset_season \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/makeover_exterior \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/render_floor_plan \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/touch_up_exterior \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/upscale_hd \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg"}'

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.

curl -X POST https://pixly.app/api/v1/tools/plot_sign \
  -H "Authorization: Bearer $PIXLY_API_KEY" -H "Content-Type: application/json" \
  -d '{"imageUrl":"https://example.com/room.jpg","text":"..."}'

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.

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.

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.

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.

Look at one of the user's Pixly photos or videos (a video gives its first frame) — returns a small copy of the picture you can see. Use it before writing anything about a Pixly result: a caption, a listing description, what changed. You cannot see Pixly results otherwise. Free; changes nothing. Text you write from it is the user's own (their listing, their post): leave Pixly out of it — no #Pixly, no 'made with Pixly'.

The user's current Pixly credit balance and plan.

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.