Jobs

Pick a result

Mark a finished photo or video version as a pick (picked: true) or remove the mark (picked: false). Picks are the versions the user wants to keep; get_download_link with picks_only downloads them together. The pick is a flag stored in the connected PropertyPixel workspace: it doesn't contact any outside service, and it never changes or deletes the version itself. Only completed enhancement, staging and video jobs can be picked.

Works with view-only access.

patch/jobs/{id}/pick

Request

  • Base URL: https://api.propertypixel.app/v1
  • URL: https://api.propertypixel.app/v1/jobs/{id}/pick
  • 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)

Path parameters

idstring uuid required

Job ID of the finished version.

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

pickedboolean required

True to pick, false to unpick.

Response

Pick a result

object'job' required
idstring uuid required
kind'enhancement' | 'staging' | 'video' required
status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' required
progressnumber nullable required

Percent complete while processing.

stagestring nullable required
project_idstring uuid nullable required
photo_idstring uuid nullable required

Source photo (null for multi-photo videos).

photo_idsstring[] required

All source photos, in order (videos can have up to 9).

source_job_idstring uuid nullable required

Prior version this edit was applied on top of.

enhancement_typesstring[] required
design_stylestring nullable required
ultra_hdboolean required
creditsinteger nullable required
pickedboolean required
watermarkedboolean required
created_atstring date-time required
completed_atstring date-time nullable required

Changes

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