Enlarge a finished render
Costs tokens and is asynchronous, exactly like a render: poll the returned job. A render that is not finished, or already upscaled, is refused with the API's own explanation.
Request
- Base URL: https://api.getfacade.ai/api/v1
- URL: https://api.getfacade.ai/api/v1/renders/{render}/upscale
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://api.getfacade.ai/oauth/authorize, token URL https://api.getfacade.ai/oauth/token, scopes: agent)
Path parameters
Headers
Names this order so a retry of it is answered rather than performed again. Required on every paid call made with an agent key: without it the call answers 422 IDEMPOTENCY_KEY_REQUIRED before anything is queued. (Optional for an app session, which is the only other caller of these paths.)
Any value of 8 to 191 characters, unique per account; a UUID per order is the usual choice. A repeat carrying the same value and the same body gets the original status and body back, with Idempotent-Replay: true on the response. The same value with a DIFFERENT body answers 422 IDEMPOTENCY_KEY_REUSED. A refusal (any 4xx) releases the value, so the same one can be sent again once the reason is fixed. Remembered for 24 hours.
A new order needs a new value. Two identical calls under two values are two designs, which is what exploring variants looks like on the wire.
Response
The render is already upscaled; its file URL is returned and nothing was charged.
Changes
No recorded changes to this operation across all 1 revision of this API.