PropertyPixel Docs
API referenceDownloads

Check a zip download

GET
/downloads/{id}

Check a zip started by get_download_link. While status is processing, wait poll_after_ms and call again; when ready, url is the zip (valid for 1 hour). If it failed, call get_download_link again.

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

Download ID from get_download_link.

Match^run_[A-Za-z0-9]+$

Response Body

Check a zip download

application/json
  1. response
object*string
id*|

Zip download ID to poll with get_download while status is processing. Null when the links are ready immediately.

status*string
Value in"processing""ready""failed"
url*|

The file to download: the single version, or the zip once ready. Null while processing, and when files lists per-file links instead.

filename*string|null
expires_at*|

When url stops working.

files*array<>

One signed link per file. Used instead of a zip whenever videos are included (videos are too large to zip server-side).

file_count*integer|null
unavailable_job_ids*array<string>

Requested versions left out because they were deleted, unfinished or failed to package.

poll_after_ms*integer

0 unless status is processing.

curl -X GET "https://example.com/downloads/string"
{  "object": "download",  "id": "string",  "status": "processing",  "url": "http://example.com",  "filename": "string",  "expires_at": "2019-08-24T14:15:22Z",  "files": [    {      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",      "kind": "photo",      "filename": "string",      "url": "http://example.com",      "expires_at": "2019-08-24T14:15:22Z"    }  ],  "file_count": 0,  "unavailable_job_ids": [    "string"  ],  "poll_after_ms": 0}

Get a download link POST

Get download links for finished results. Pass job_ids (1–100 completed versions from one project), or project_id to download that project's picks (picks_only defaults to true; false downloads every finished version, up to 100). One version returns a signed link immediately. Several photos start a zip: status is processing, so call get_download with the returned id after poll_after_ms. If any videos are included you get one signed link per file in `files` instead of a zip. Links last 1 hour; trial accounts get watermarked files. Works with view-only access.

Create a quote POST

Price a spending request without running it. Pass the returned id as quote_id to the operation within 10 minutes. Requires a connection with edit access.