Reveal

RevealTemplate

A rectangular or circular mask opens as the image scales up to fill the frame.

Showreel 7 of 14 · 1 to 30 images or videos

0:00 / 0:00

Settings

Template settings

Specific to this template. Every template also accepts the common settings (aspect ratio, background, corner radius).

Setting	Type	Default	What it does
`transitionDuration`	number	`0.6`	Seconds for each reveal.
`holdDuration`	number	`0.2`	Gap between reveals (negative = overlap).
`transitionStyle`	enum	`smooth`	Easing of the reveal.One of: `smooth`, `snap`, `elastic`
`startScale`	number	`0.8`	Media scale when it first appears (e.g. 0.8 = 80%).
`maskShape`	enum	`rect`	Shape of the reveal mask.One of: `rect`, `circle`
`revealOrigin`	enum	`center`	Where the mask grows from.One of: `top-left`, `top-right`, `center`, `bottom-left`, `bottom-right`
`mediaFit`	enum	`crop`	How each media fills its slot.One of: `crop`, `contain`, `natural`
`imagePosition`	number	`0`	Vertical crop anchor 0–100 (crop only).

Request

Example request

A complete, working body for POST /api/v1/render with every default spelled out. Send only the settings you want to change.

POST /api/v1/render — Reveal

{
  "id": "RevealTemplate",
  "scale": 1,
  "inputProps": {
    "images": [
      "https://picsum.photos/seed/reelfolio1/1280/800",
      "https://picsum.photos/seed/reelfolio2/1280/800",
      "https://picsum.photos/seed/reelfolio3/1280/800"
    ],
    "settings": {
      "backgroundColor": "#0a0a0a",
      "backgroundType": "color",
      "backgroundLibraryCategory": "same",
      "backgroundLibraryImage": "https://cdn.reelfolio.io/reelfolio-background-library/raycast/autumnal-peach.webp",
      "blurAmount": 0,
      "backgroundOpacity": 1,
      "borderRadius": 0,
      "aspectRatio": "16:9",
      "cropAspectRatio": "16:9",
      "transitionDuration": 0.6,
      "holdDuration": 0.2,
      "transitionStyle": "smooth",
      "startScale": 0.8,
      "maskShape": "rect",
      "revealOrigin": "center",
      "mediaFit": "crop",
      "imagePosition": 0
    }
  }
}