PropertyPixel Docs
API referenceJobs

Get a job

GET
/jobs/{id}

Get one job's status, progress and result URL (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

Job 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

Get a job

application/json
  1. response
object*string
id*string
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
kind*JobKind
Value in"enhancement""staging""video"
status*JobStatus
Value in"pending""processing""completed""failed""cancelled"
progress*|

Percent complete while processing.

stage*string|null
project_id*|null
photo_id*|

Source photo (null for multi-photo videos).

photo_ids*array<>

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

source_job_id*|

Prior version this edit was applied on top of.

enhancement_types*array<string>
design_style*string|null
ultra_hd*boolean
credits*integer|null
picked*boolean
watermarked*boolean
result*|

The finished image or video, when completed.

thumbnail*|null
error*|

Why the job failed. Failed jobs are refunded automatically.

created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
completed_at*|null
curl -X GET "https://example.com/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"}

Check job status GET

Check progress of up to 100 jobs returned by enhance_photos, stage_photos, apply_recommendations or create_video. Returns status (pending, processing, completed, failed, cancelled), progress, result URLs (signed for 1 hour) and a poll_after_ms hint. Photo edits usually finish in under a minute and videos in a few minutes; wait poll_after_ms between checks instead of calling in a tight loop. Failed jobs are refunded automatically. Works with view-only access.

Pick a result PATCH

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. Picks are shared by the workspace and never change or delete the versions themselves. Only completed enhancement, staging and video jobs can be picked. Works with view-only access.