PropertyPixel Docs

API reference

Every REST endpoint, generated from the same operations as the MCP tools.

The REST API lives at https://api.propertypixel.app/v1. Every endpoint matches an MCP tool: same parameters, same result.

curl https://api.propertypixel.app/v1/account \
  -H "Authorization: Bearer $PP_API_KEY"
  • Authentication: a personal API key (pp_live_…) or an OAuth access token, sent as a bearer token. See Authentication.
  • OpenAPI: the full OpenAPI 3.1 document is at https://api.propertypixel.app/v1/openapi.json. Import it into Postman, Insomnia or a client generator.
  • Spending credits: spending endpoints return a quote first. Confirm with quote_id, or send auto_confirm: true with an API key. See Credits and quotes.
  • Conventions: errors use RFC 9457 problem details (Errors). Writes accept an Idempotency-Key, lists page with cursor, and every response carries rate-limit headers.

Endpoints

GroupWhat it covers
AccountThe connected workspace, plan and credit balance
ProjectsCreate, list, read and delete listing projects; show results
PhotosAdd photos by URL, or delete them
UploadsSigned uploads and upload links
Edit optionsEvery enhancement type, staging style and video setting
EditingEnhance and virtually stage photos
VideoPhoto to Video clips and Listing Tours
RecommendationsFree AI suggestions per photo, and applying them
JobsJob status and details, and picking favourite results
DownloadsSigned download links and zips
QuotesPrice a spending request before running it

On this page