Recommendations

Apply recommendations

Run ready Recommendations from get_recommendations as enhancement jobs: one job per photo with all its suggested edits. Costs 100 credits per Recommendation. Only status ready can be applied.

Spends credits in two steps. Call without quote_id first: you get a quote and nothing is spent. Show the cost to the user and wait for a yes, then call again with the same arguments plus quote_id. The quote lasts 10 minutes and only matches identical arguments.

Results are asynchronous: poll get_job_status with the returned job IDs, waiting poll_after_ms between calls. Failed jobs are refunded automatically.

Requires a connection with edit access. Spends credits. Without quote_id it returns 409 quote_required with a quote and spends nothing. Resend with quote_id to run, or send auto_confirm: true to skip the quote.

post/recommendations/apply

Request

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

recommendation_idsstring[] required

IDs of Recommendations with status ready, from get_recommendations.

quote_idstring uuid

The id of a quote the user confirmed. Omit it to get a quote first; nothing is spent without one.

auto_confirmboolean

REST with a personal API key only. Skip the quote step and spend immediately. For trusted scripts; ignored for app (OAuth) connections, which always get a quote.

Response

Apply recommendations

object'job_batch' required
credits_spentinteger required
poll_after_msinteger required

Suggested wait before calling get_job_status.

Changes

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