Downloads

Get a download link

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.

post/downloads

Request

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

job_idsstring[]

Completed job IDs from one project (max 100).

project_idstring uuid

Download from this project instead of listing job_ids.

picks_onlyboolean

With project_id: only the picked versions (default true).

Response

Get a download link

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.