runelore.compose_preview
Place supplied or library artwork on a product. Returns temporary previews; never publishes inventory.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| product | Yes | Canonical numeric product ID from get_product_blueprint, supplied as a string (for example "19"). | |
| designId | No | Case-sensitive artwork ID returned by search_designs; supply this or fileBase64 plus mediaType, never both. | |
| mediaType | No | MIME type of fileBase64: image/png or image/jpeg; omit when using a library designId. | |
| placement | Yes | A placement name or surfaceId from this product blueprint with composable:true (for example "wrap" or "front"). | |
| transform | Yes | Artwork position and dimensions on the blueprint’s 1000×1000 print-area grid; X/Y anchor the unrotated top-left corner and the two axes can have different physical scales. | |
| fileBase64 | No | Standard padded base64 image bytes without a data-URL prefix; PNG/JPEG only, at most 6 MB decoded and 4096 pixels per side; use with mediaType instead of designId. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| product | Yes | Canonical physical product ID used for this composition. | |
| previews | Yes | Map of view name to absolute PNG URL; fetch exactly as returned before expiry. | |
| expiresAt | Yes | ISO 8601 UTC expiry deadline; previews normally last 30 minutes and can disappear sooner on restart or eviction. | |
| placement | Yes | Public placement name used for this composition. | |
| transform | Yes | Accepted placement on the 1000 × 1000 print-area grid. | |
| variantId | Yes | Default size/color variant selected from the product blueprint. | |
| designName | Yes | Library artwork name, or Custom design for an uploaded image. | |
| previewKind | Yes | Preview method: artwork composited onto a product photograph. | |
| compositionId | Yes | Case-sensitive temporary composition ID accepted by place_order before expiry. |