Document the designed exterior as a PDF album
The design documented for the crew that builds it: materials, the build-up of the facade, safety notes and the regulatory references behind them. Requires a finished main render on the design; without one the API refuses with 422 and an explanation. The finished album's public_url is a permanent public link that can be handed to a person as it stands.
Request
- Base URL: https://api.getfacade.ai/api/v1
- URL: https://api.getfacade.ai/api/v1/concepts/{concept}/album/generate
- 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.
Request body
Response
An album with these exact settings already exists and is returned instead of a second one: duplicate_exists is true on it. Send force_regenerate to build a new one.
Changes
No recorded changes to this operation across all 1 revision of this API.