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 sendauto_confirm: truewith an API key. See Credits and quotes. - Conventions: errors use RFC 9457 problem details (Errors). Writes accept an
Idempotency-Key, lists page withcursor, and every response carries rate-limit headers.
Endpoints
| Group | What it covers |
|---|---|
| Account | The connected workspace, plan and credit balance |
| Projects | Create, list, read and delete listing projects; show results |
| Photos | Add photos by URL, or delete them |
| Uploads | Signed uploads and upload links |
| Edit options | Every enhancement type, staging style and video setting |
| Editing | Enhance and virtually stage photos |
| Video | Photo to Video clips and Listing Tours |
| Recommendations | Free AI suggestions per photo, and applying them |
| Jobs | Job status and details, and picking favourite results |
| Downloads | Signed download links and zips |
| Quotes | Price a spending request before running it |
MCP tools
Every tool the PropertyPixel MCP server exposes.
Get account GET
Get the connected PropertyPixel account: the workspace and the user's role in it, whether this connection can make changes, the credit balance (100 credits = one photo enhancement), the plan, and whether results are watermarked (trial). Call this before spending to check the balance, or when the user asks about their credits or plan. Works with view-only access.