PropertyPixel Docs
API referenceProjects

Show results

GET
/projects/{id}/results

Show a project's edited results: what is still processing, the newest finished version of each photo and each video, and the versions the user picked. Use this when the user wants to see or review their results. Result URLs are signed for 1 hour.

Works with view-only access.

Authorization

headerAuthorizationBearer <token>

An API key from Settings → Developers (pp_live_…), or an OAuth access token.

Path Parameters

id*string

Project ID.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Show results

application/json
  1. response
object*string
project*
jobs*array<>

Jobs still running, the newest finished version of each photo and video, and every pick (newest first).

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/results"
{  "object": "results",  "project": {    "object": "project",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "address": "string",    "property_type": "string",    "photo_count": 0,    "completed_job_count": 0,    "cover": {      "url": "http://example.com",      "expires_at": "2019-08-24T14:15:22Z"    },    "studio_url": "http://example.com",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "jobs": [    {      "object": "job",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "enhancement",      "status": "pending",      "progress": 0,      "stage": "string",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "photo_id": "50c42bd2-615e-4fec-a325-0e5c4d3d73d3",      "photo_ids": [        "68e4fc1a-5272-4c7c-88ae-00ad654f19af"      ],      "source_job_id": "82ec7aa8-71eb-48cf-81de-c1b18e40e554",      "enhancement_types": [        "string"      ],      "design_style": "string",      "ultra_hd": true,      "credits": 0,      "picked": true,      "watermarked": true,      "result": {        "url": "http://example.com",        "expires_at": "2019-08-24T14:15:22Z"      },      "thumbnail": {        "url": "http://example.com",        "expires_at": "2019-08-24T14:15:22Z"      },      "error": {        "code": "string",        "message": "string"      },      "created_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z"    }  ]}

Delete a project DELETE

Delete a project with all its photos and edited results. Only do this when the user explicitly asks to delete that project; confirm the project name with them first. It disappears from the Studio immediately. Requires a connection with edit access.

Add photos to a project POST

Add photos to a project from public https image URLs (`image_urls`) or from files the user attached in ChatGPT (`files`). Up to 25 photos per call; a project holds at most 100. Each file must be JPEG, PNG, WebP, HEIC or HEIF and at most 25 MB. Dropbox and Google Drive share links work if they are shared publicly. HEIC is converted to JPEG and large photos are downscaled to a 2048px long edge, like the web app. Returns the new photos (use their IDs with enhance_photos, stage_photos or create_video) and a `failed` list with a reason per source; report failures to the user rather than retrying blindly. If the user has photos on their phone or computer and no links, call create_upload_link instead. Requires a connection with edit access.