Jobs

Check job status

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.

get/jobs

Request

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

Query parameters

idsstring[] required

Job IDs, as an array or comma-separated (max 100).

Response

Check job status

object'job_status' required
all_doneboolean required

True when every job is completed, failed or cancelled.

poll_after_msinteger required

Wait this long before polling again. 0 means nothing is left to wait for.

Changes

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