Estimates

Price the design again

A fresh generation of the same estimate from its renders, at the current prices. Costs the same as ordering one. An estimate carrying manual line edits answers 409 COST_ESTIMATE_OVERWRITE_REQUIRED unless confirm_overwrite is true, so a stray call never discards hand-tuned numbers.

post/estimates/{estimate}/regenerate

Request

  • Base URL: https://api.getfacade.ai/api/v1
  • URL: https://api.getfacade.ai/api/v1/estimates/{estimate}/regenerate
  • 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

estimatestring required

Headers

Idempotency-Keystring required

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.

Request body

Response

A JSON:API document

Changes

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