Skip to main content
GET
Get a 3D scene

Authorizations

Authorization
string
header
required

A secret key from Print.App admin → Domains → Secret keys, sent as Authorization: Bearer sk_…. Server-side only.

Path Parameters

id
string
required

The scene id (scene_…).

Query Parameters

designId
string

Say whether the scene suits this design (fit).

Response

OK.

A 3D scene the editor can preview a design on: a 3D model with print areas (a mug, a T-shirt), a fold, a flipbook or a sheet. Yours, or from the Print.App library.

object
string
required
Allowed value: "scene"
id
string
required
title
string | null
required
description
string | null
required
kind
enum<string> | null
required
Available options:
model,
fold,
flipbook,
sheet,
null
source
enum<string>
required

One of your scenes, or from the Print.App library.

Available options:
yours,
library
thumbnailUrl
string | null
required
printAreas
object[]
required

A model's print areas, and the design page (from 1) each one shows.

fold
object | null
required

A fold: page 1 is the outside, page 2 the inside.

sizeMm
object | null
required

The flat size (a flipbook: one page).

sizeFrom
enum<string> | null
required

artwork: the preview takes the design's size (the size above is only a preview size). fixed: the scene keeps its own size.

Available options:
artwork,
fixed,
null
pagesShown
integer | null
required

How many of the design's pages the scene shows; null: all of them (a flipbook).

created
string<date-time> | null
required
modified
string<date-time> | null
required
fit
object

With ?designId=: whether the scene suits that design.