---
title: "Sky Replacement"
method: POST
path: "/api/v1/tools/replace_sky"
tags: ["Tools"]
---

# Sky Replacement

`POST /api/v1/tools/replace_sky`

## Request

- Base URL: `https://pixly.app`
- URL: `https://pixly.app/api/v1/tools/replace_sky`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://pixly.app/oauth/authorize`, token URL `https://pixly.app/api/oauth/token`, scopes: `tools`)

Replace a grey, overcast or blown-out sky in an exterior listing photo with a natural clear blue sky, matching the light and keeping the building, trees and reflections unchanged. A run takes about 1–2 minutes; poll get_job until it completes.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `imageUrl` string: Public https URL of the source photo, or a data: URI. Either imageUrl or r2Path is required.
  - `r2Path` string: Storage path of a photo already in the user's Pixly library (from list_library, or returned by an upload ticket) — the alternative to imageUrl.
  - `sky` 'auto' | 'clear' | 'light_clouds' | 'dramatic_clouds' | 'sunset' | 'pastel_sunrise' | 'winter_clear': Sky style. 'auto' lets the tool pick what suits the photo's light.
  - `sun` 'auto' | 'on' | 'off': Sun glow: auto (a glow for sunset/sunrise styles, none otherwise), on (place it with sunX/sunY), off.
  - `sunX` number: With sun=on: glow position from the left edge, 0..1.
  - `sunY` number: With sun=on: glow position from the top edge, 0..1 (kept in the top 60%).

## Response `200`

Finished inline — resultUrls present (photo tools)

- Job
  - `jobId` string, required: Job id — pass to get_job to poll
  - `type` 'image_staging' | 'video_pair' | 'video_tour', required: Job family
  - `status` 'pending' | 'processing' | 'completed' | 'failed', required: Anything not completed/failed is still running
  - `creditsCharged` number, nullable, required: Credits debited for this job
  - `createdAt` string, date-time, required: Submission time
  - `completedAt` string, date-time: Present once finished
  - `resultUrls` string[]: Presigned download URLs (present when completed; valid 7 days)
  - `resultPaths` string[]: Storage path of each result, in resultUrls order — pass one as r2Path (or beforeR2Path, a photos[] item…) to run another tool on this result
  - `error` string: Failure reason; the message says whether the credit came back immediately or is in 24h refund review
  - `note` string: Hint for agents, e.g. poll again in a few seconds

## Other responses

- `202`: Accepted and running — poll GET /api/v1/jobs/{id} (video tools)
- `401`: Missing/invalid credential
- `402`: Out of credits, or no active subscription (error.required = credits needed) — POST /api/v1/checkout returns a payment link
- `409`: A request with the same Idempotency-Key is still running — retry in a few seconds for its result
- `410`: Source photo no longer available — re-upload
- `422`: Invalid input — error.issues lists the offending fields
- `429`: Rate limited — see Retry-After (120 req/min, 30/min for generations)

---

[API](https://skmtc.dev/pixly/apis/pixly-api.md) · [All operations](https://skmtc.dev/pixly/apis/pixly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pixly/apis/pixly-api/revisions/6f1aae1786ea?raw)