Gallery Platform API
Reference

Preview a work to scale in a room

Renders the work hanging to true scale in the chosen room scene and returns a short-lived signed image URL. Deterministic and cached by storage path.

POST
/gallery/artworks/{id}/room-preview

Renders the work hanging to true scale in the chosen room scene and returns a short-lived signed image URL. Deterministic and cached by storage path.

Authorization

bearerAuth artworks:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: artworks:read

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Render this work to scale in the given room scene.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "preview_url": "string"}