Recommendations

Get edit recommendations

Free. Ask PropertyPixel's AI which corrective edits each photo needs (e.g. improve_lighting, clean_and_tidy, straighten_and_reframe). Select photos with photo_ids, or project_id + all_photos: true.

Returns the Recommendations that already exist and starts analysis for photos that have none. Analysis is asynchronous: photos in pending_photo_ids are still being analysed, so call again after poll_after_ms to see them. A daily analysis limit applies; photos over it are listed in skipped_photo_ids.

To run the suggestions, pass the ready Recommendation IDs to apply_recommendations (paid).

Requires a connection with edit access.

post/recommendations

Request

  • Base URL: https://api.propertypixel.app/v1
  • URL: https://api.propertypixel.app/v1/recommendations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/authorize, token URL https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/token)

Headers

Idempotency-Keystring

A unique key (for example a UUID) that makes retries safe. A retry with the same key and body returns the stored response; the same key with a different body returns 422. Keys last 24 hours.

Request body

photo_idsstring[]

The photos to use. Get IDs from get_project. Alternatively pass project_id with all_photos: true.

project_idstring uuid

The project the photos belong to. Required with all_photos; with photo_ids it must match their project.

all_photosboolean

Use every photo in project_id instead of listing photo_ids.

Response

Get edit recommendations

object'recommendation_list' required
pending_photo_idsstring[] required

Photos still being analysed. Call again after poll_after_ms.

skipped_photo_idsstring[] required

Photos with no Recommendation that could not be queued now (daily analysis limit reached, or the photo is not in a project).

poll_after_msinteger required

Wait this long before calling again; 0 when nothing is pending.

Changes

No recorded changes to this operation across all 1 revision of this API.