canonical: https://jentic.com/apis/pixly.app/pixly

# Pixly App Pixly API

The Pixly API turns real estate listing photos into virtually staged rooms, edited images, and short property videos. Each tool has its own operation, from virtual staging in a chosen interior style and furniture removal to sky replacement, day-to-night conversion, floor plan rendering, and photo-to-video camera moves. A tool call takes an imageUrl or an r2Path from your Pixly library; when it answers 202 you poll the job until its status is completed, then download the resultUrls. Generation tools spend credits from the account's Pixly balance, which you can read alongside the active plan.

## For AI agents

Stage empty rooms, declutter or restyle listing photos, replace skies and lawns, and generate property videos from photos, then poll each job for its result URLs. Covers uploads, the tool list, job history, the library, and the credit balance.

## Scope

Does not handle property listing data, MLS publishing, or general video editing timelines. Use for staging, editing, and animating real estate photos only.

## Capabilities

- Virtually stage an empty or badly furnished room photo in a chosen interior style such as scandinavian, japandi, or mid-century-modern
- Clean up listing photos by decluttering, removing furniture, straightening, enhancing, or upscaling them to HD
- Change a property's look with sky replacement, lawn replacement, day-to-night conversion, seasonal reset, or an exterior makeover
- Generate property videos from photos, including photo-to-video camera moves such as orbitLeft or pushIn, flythroughs, and before-and-after reels
- Draw or render floor plans and add watermarks, plot number signs, or face and licence plate blurring to listing images
- Poll a generation job for its status, credits charged, and presigned resultUrls, and chain a result into another tool by its resultPaths
- Import a photo from a URL or get a presigned upload ticket for a local file, and check the remaining credit balance

## Use cases

### Agent-Driven Listing Photo Staging via Jentic

A real estate assistant agent receives empty-room photos from an agent or photographer and needs staged versions for the listing. Through Jentic it calls the virtual_staging tool with the imageUrl and a style such as scandinavian, polls get_job until the status is completed, and returns the staged image URLs, checking the credit balance first so a run does not stop halfway with a 402.

Example prompt: Read the account's creditsRemaining, then stage three empty bedroom photos in the japandi style with virtual_staging, poll each job until completed, and return the resultUrls

### Listing Photo Clean-Up Before Publishing

Photographers and listing coordinators prepare a shoot for publication by running the clean-up tools: declutter_photo and remove_furniture for interiors, straighten_photo for crooked verticals, replace_sky and replace_lawn for exteriors, and blur_faces_plates for privacy. Each result's resultPaths entry can be passed as the r2Path of the next tool, so several edits chain without re-uploading.

Example prompt: Run replace_sky on an exterior photo, then pass the job's first resultPaths entry as r2Path to blur_faces_plates and return the final result URL

### Property Videos from Still Photos

Agents who want short listing videos without a video shoot generate them from photos. The photo_to_video tool moves the camera from a start photo, optionally landing on an end photo of the same space, with ready-made moves such as smooth, walk, or riseUp, while flythrough_video and before_after_reel produce tour and comparison clips for social posts.

Example prompt: Create a photo_to_video job from two kitchen photos using endImageUrl and the orbitRight cameraMove, then poll get_job and return the video URL

### Renovation and Restyle Previews

Buyers and sellers want to see what a room or facade could look like. The restyle_room, makeover_exterior, and touch_up_exterior tools produce previews of a new interior style or refreshed exterior, and before_after_image composes the original and result side by side for a listing or a client message.

Example prompt: Restyle a dated living room photo with restyle_room, then build a before_after_image from the original and the result and return the comparison URL

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/tools/virtual_staging` | Stage a room photo in an interior style |
| POST | `/api/v1/tools/photo_to_video` | Turn one or two photos into a video |
| POST | `/api/v1/tools/replace_sky` | Replace the sky in an exterior photo |
| POST | `/api/v1/tools/declutter_photo` | Declutter a room photo |
| GET | `/api/v1/jobs/{id}` | Poll a job for status and result URLs |
| POST | `/api/v1/uploads` | Import a photo or get an upload ticket |
| GET | `/api/v1/tools` | List tools with input schemas |
| GET | `/api/v1/account` | Read credit balance and plan |

## Key resources

- **Tools** — The tool list with input schemas, plus one operation per image and video tool such as virtual staging, decluttering, sky replacement, and photo-to-video.
- **Jobs** — Poll a job by id for status, credits charged, resultUrls, and resultPaths, or list recent image and video generations.
- **Library** — Browse results or uploads with thumbnail, file, and source links.
- **Uploads** — Import a photo from a URL or get a presigned PUT ticket for a local file.
- **Account and checkout** — Read the credit balance and plan, and get a checkout link for the account holder to pay on.

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 89 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 66 / 100
- **View full report:** https://jentic.com/apis/pixly.app/pixly/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Pixly by hand means choosing between a pixly_sk_ bearer key and OAuth 2.1 with PKCE, uploading photos or presigned tickets, and writing the 202-then-poll loop for every generation. Through Jentic you install once, import Pixly from the API Directory, store the credential once, and your agent runs the tools.
- **Permission scoping:** Every Pixly tool has its own path under `/api/v1/tools`/, so rules bound which tools your agent may call: virtual staging can be allowed while video generation and checkout stay off the list. You choose the operations it may call, so credit-spending tools are not included unless you add them.
- **Credential handling:** Your Pixly API key or OAuth token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'virtually stage a room' or 'turn a photo into a video', and Jentic returns the matching Pixly tool operation with its input schema so the agent picks the right tool without browsing the reference docs.

## Related APIs

- **Claid** — Claid offers general AI photo enhancement and product imagery; Pixly is built around real estate listing photos, staging, and property videos.
- **Photoroom** — Photoroom specialises in background removal and product shots; Pixly stages rooms and edits property exteriors.
- **RentCast** — RentCast supplies property records and rent estimates; Pixly prepares the listing photos and videos for the same property.
- **Shotstack** — Shotstack edits and renders videos from timelines; it can assemble Pixly's generated clips into a longer property tour.

## FAQ

### What authentication does the Pixly API use?

Per its OpenAPI spec, the Pixly API accepts two schemes: a bearer API key of the form pixly_sk_... created in your Pixly account settings, or OAuth 2.1 with PKCE through the authorization code flow with the tools scope, which covers running tools with the account's credits and reading its jobs and balance. Through Jentic the key or token is stored encrypted on your own instance and injected at call time.

### Is there a Pixly MCP server?

You don't need an MCP server to give your agent Pixly. Jentic connects it directly from the API Directory: import Pixly, store your credential once, and your agent can stage photos and generate videos straight away. Operations are discovered on demand, so no extra server's tool definitions sit in your agent's context.

### Can I limit what my agent is allowed to do with the Pixly API?

Yes. Write a rule that allows only the virtual_staging, replace_sky, and get_job operations, so the agent can stage rooms, swap skies, and poll for results but cannot start credit-heavy video tools or open a checkout link, and every call it makes is logged.

### How do I get the result of a Pixly tool call?

If a tool answers 202, the work runs as a job: poll get_job at `/api/v1/jobs/{id}` until the status is completed or failed. A completed job carries presigned resultUrls valid for 7 days, plus resultPaths you can pass as r2Path to run another tool on the result without uploading it again.

### What are the rate limits for the Pixly API?

The Pixly OpenAPI spec states 120 requests per minute, with generations limited to 30 per minute. A rate-limited call returns 429 with a Retry-After header saying when to try again.

### How do I stage a room photo with the Pixly API through Jentic?

Search Jentic for an intent like 'virtually stage a room photo', import Pixly, and store your API key once. Your agent then calls the virtual_staging operation at `/api/v1/tools/virtual_staging` with an imageUrl and a style, and polls get_job for the staged image. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Does the Pixly API charge credits for every call?

No. Generation tools spend credits from the account's Pixly balance, and each job reports creditsCharged. Reading the account, jobs, library, and tool list does not run a generation. When the balance is empty or there is no active plan, tools answer 402 and the checkout operation returns a payment link for the account holder.