Uploads

Create an upload link

Create a private link (with a QR code) the user opens on their phone or computer to add photos to a project, with no login. Use it when the user needs to send photos you can't receive directly, such as photos on their phone. Share the url, or show the QR code, and tell the user the link works for 2 hours. Photos appear in the project as they upload. To follow progress, call get_project and read upload_link.status and upload_link.photos_received until status is done (the user tapped Done), or simply ask the user to tell you when they've finished.

Requires a connection with edit access.

post/projects/{project_id}/upload-links

Request

  • Base URL: https://api.propertypixel.app/v1
  • URL: https://api.propertypixel.app/v1/projects/{project_id}/upload-links
  • 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

project_idstring uuid required

The project the photos go into.

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.

Response

Create an upload link

object'upload_link' required
idstring uuid required
urlstring uri required

Share this with the user. It opens a page that adds photos to the project, with no login. Treat it like a password.

qr_svgstring required

The same URL as a QR code (SVG markup), for scanning with a phone.

expires_atstring date-time required
status'waiting' | 'receiving' | 'done' | 'expired' required
photos_receivedinteger required
max_photosinteger required

How many photos this link accepts (the project's free space).

project_idstring uuid required

Changes

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