Downloads

Check a zip download

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.

get/downloads/{id}

Request

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

Download ID from get_download_link.

Response

Check a zip download

object'download' required
idstring nullable required

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

status'processing' | 'ready' | 'failed' required
urlstring uri nullable required

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

filenamestring nullable required
expires_atstring date-time nullable required

When url stops working.

file_countinteger nullable required
unavailable_job_idsstring[] required

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

poll_after_msinteger required

0 unless status is processing.

Changes

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