> ## Documentation Index
> Fetch the complete documentation index at: https://print.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a 3D scene

> Returns one scene: its kind, print areas or panels, size, and how many of a design's pages it shows. With `designId`, whether it suits that design: every print area has a page, a fold has its inside page, a fixed size matches.



## OpenAPI

````yaml openapi.json GET /v2/scenes/{id}
openapi: 3.1.0
info:
  title: Print.App API
  version: 2.1.0
  description: >-
    Server-to-server API for Print.App integrations: designs and their page
    content, folders, files, fonts, palettes, product assignments, projects and
    editor links. Authenticate every request with a secret key: `Authorization:
    Bearer sk_…`. Never call it from a browser.
servers:
  - url: https://api.print.app
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The account a secret key belongs to.
  - name: Designs
    description: >-
      The designs (templates) your customers start from: create them at a size,
      manage their pages, and place text, images and shapes on them.
  - name: Design folders
    description: >-
      Folders that organise your designs. A design can sit in more than one
      folder.
  - name: Files
    description: >-
      Your own images and graphics, used in designs and offered to customers in
      the editor.
  - name: Graphic folders
    description: >-
      Folders of files, shown in the editor under Pictures, Backgrounds,
      Textures or Frames.
  - name: Fonts
    description: >-
      The fonts your designs and customers can use: the built-in set, imported
      Google fonts and fonts you upload.
  - name: Palettes
    description: Colour palettes offered in the editor.
  - name: Products
    description: Which designs open for each product (and variant) in your store.
  - name: Projects
    description: Your customers' saved designs.
  - name: Links
    description: Shareable editor links that open a design or project at create.print.app.
  - name: Connectors
    description: >-
      Links between the options on a store's product page and the editor: the
      choice a customer makes shows the right pages, opens the right design, or
      sets the size, orientation or colour. Read a product page for what a
      connector can point at, and test one against a design before customers
      meet it.
  - name: Resource profiles
    description: >-
      Limits on the fonts, colour palettes and graphic folders the editor
      offers, for the designs that use them.
  - name: PDF profiles
    description: >-
      The settings print PDFs are made with: colour conversion, PDF standard,
      cut lines, image resolution, fonts.
  - name: 3D scenes
    description: >-
      The 3D scenes the editor previews designs on: models with print areas,
      folds, flipbooks and sheets, yours and the Print.App library's. A design
      picks one with `sceneId`.
  - name: Settings
    description: >-
      The account's editor and product page settings: how the editor opens and
      behaves, and the selectors Print.App uses on your product pages. Settings
      that run code in your store, send data elsewhere or delete projects are
      kept to the dashboard.
paths:
  /v2/scenes/{id}:
    get:
      tags:
        - 3D scenes
      summary: Get a 3D scene
      description: >-
        Returns one scene: its kind, print areas or panels, size, and how many
        of a design's pages it shows. With `designId`, whether it suits that
        design: every print area has a page, a fold has its inside page, a fixed
        size matches.
      operationId: getScene
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The scene id (`scene_…`).
        - required: false
          name: designId
          in: query
          schema:
            type: string
          description: Say whether the scene suits this design (`fit`).
      responses:
        '200':
          description: OK.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scene'
              example:
                object: scene
                id: scene_01M3PBRXG4JFN6NZSXJVKHX68F
                title: Tri-fold
                description: null
                kind: fold
                source: library
                thumbnailUrl: https://cdn.print.app/scenes/tri-fold.webp
                printAreas: []
                fold:
                  type: roll
                  panels: 3
                  creaseAxis: vertical
                sizeMm:
                  width: 297
                  height: 210
                sizeFrom: artwork
                pagesShown: 2
                fit:
                  ok: true
                  notes: []
                created: '2026-09-21T08:14:30Z'
                modified: '2026-09-21T08:14:30Z'
        '400':
          description: >-
            A parameter or body field is malformed: `param` names it and
            `details` lists every problem found.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: invalid_request
                message: width is required.
                param: width
                requestId: FZn-uhymjoEEJow=
        '401':
          description: Missing, unknown, revoked or expired secret key.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: unauthorized
                message: >-
                  Missing or invalid secret key. Send it as "Authorization:
                  Bearer sk_…".
                requestId: FZn-uhymjoEEJow=
        '403':
          description: The account is suspended for an unpaid invoice.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: account_suspended
                message: >-
                  This account is suspended. Settle the outstanding invoice in
                  the Print.App dashboard.
                requestId: FZn-uhymjoEEJow=
        '404':
          description: >-
            Not found in your account. Another account's resources answer 404
            too.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: not_found
                message: Not found.
                requestId: FZn-uhymjoEEJow=
        '429':
          description: >-
            Rate limited by the API gateway. Back off and retry. This response
            comes from the gateway, so its body is `{ "message": "Too Many
            Requests" }`, not the standard error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                message: Too Many Requests
        '500':
          description: >-
            Something failed on our side. Retry; quote the requestId to support
            if it persists.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: true
                code: internal_error
                message: >-
                  Something went wrong on our side. Retry the request; if it
                  keeps failing, contact support with the requestId.
                requestId: FZn-uhymjoEEJow=
components:
  headers:
    RequestId:
      description: Identifies the request. Quote it when contacting support.
      schema:
        type: string
  schemas:
    Scene:
      title: Scene
      description: >-
        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.
      type: object
      properties:
        object:
          type: string
          const: scene
        id:
          type: string
        title:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        kind:
          type:
            - string
            - 'null'
          enum:
            - model
            - fold
            - flipbook
            - sheet
            - null
        source:
          type: string
          enum:
            - yours
            - library
          description: One of your scenes, or from the Print.App library.
        thumbnailUrl:
          type:
            - string
            - 'null'
        printAreas:
          type: array
          description: A model's print areas, and the design page (from 1) each one shows.
          items:
            type: object
            required:
              - id
              - label
              - page
            properties:
              id:
                type: string
              label:
                type:
                  - string
                  - 'null'
              page:
                type: integer
        fold:
          type:
            - object
            - 'null'
          required:
            - type
            - panels
            - creaseAxis
          description: 'A fold: page 1 is the outside, page 2 the inside.'
          properties:
            type:
              type:
                - string
                - 'null'
              description: bi, roll, z, gate or custom.
            panels:
              type:
                - integer
                - 'null'
            creaseAxis:
              type: string
        sizeMm:
          type:
            - object
            - 'null'
          required:
            - width
            - height
          description: 'The flat size (a flipbook: one page).'
          properties:
            width:
              type: number
            height:
              type: number
        sizeFrom:
          type:
            - string
            - 'null'
          enum:
            - artwork
            - fixed
            - null
          description: >-
            artwork: the preview takes the design's size (the size above is only
            a preview size). fixed: the scene keeps its own size.
        pagesShown:
          type:
            - integer
            - 'null'
          description: >-
            How many of the design's pages the scene shows; `null`: all of them
            (a flipbook).
        fit:
          type: object
          required:
            - ok
            - notes
          description: 'With ?designId=: whether the scene suits that design.'
          properties:
            ok:
              type: boolean
              description: >-
                false when the preview would show the design wrongly (a blank
                print area, a stretched size).
            notes:
              type: array
              items:
                type: string
        created:
          type:
            - string
            - 'null'
          format: date-time
        modified:
          type:
            - string
            - 'null'
          format: date-time
      examples:
        - object: scene
          id: scene_01M3PBRXG4JFN6NZSXJVKHX68F
          title: Tri-fold
          description: null
          kind: fold
          source: library
          thumbnailUrl: https://cdn.print.app/scenes/tri-fold.webp
          printAreas: []
          fold:
            type: roll
            panels: 3
            creaseAxis: vertical
          sizeMm:
            width: 297
            height: 210
          sizeFrom: artwork
          pagesShown: 2
          fit:
            ok: true
            notes: []
          created: '2026-09-21T08:14:30Z'
          modified: '2026-09-21T08:14:30Z'
      required:
        - object
        - id
        - title
        - description
        - kind
        - source
        - thumbnailUrl
        - printAreas
        - fold
        - sizeMm
        - sizeFrom
        - pagesShown
        - created
        - modified
    Error:
      title: Error
      description: >-
        Every error the API itself returns. Match on `code`; `message` is for
        people and may be reworded.
      type: object
      required:
        - error
        - code
        - message
        - requestId
      properties:
        error:
          type: boolean
          const: true
        code:
          type: string
          enum:
            - unauthorized
            - account_suspended
            - invalid_request
            - not_found
            - route_not_found
            - idempotency_key_reused
            - idempotency_in_progress
            - folder_not_empty
            - builtin_folder
            - builtin_palette
            - editor_not_supported
            - design_changed
            - payload_too_large
            - unsupported_media_type
            - ops_failed
            - internal_error
            - service_unavailable
          description: >-
            `unauthorized` (401): missing, unknown, revoked or expired secret
            key. `account_suspended` (403): the account has an unpaid invoice.
            `invalid_request` (400): a parameter or body field is malformed —
            see `param` and `details`. `not_found` (404): no such resource in
            your account. `route_not_found` (404): no such endpoint.
            `idempotency_key_reused` (409): the Idempotency-Key was used for a
            different request. `idempotency_in_progress` (409): the first
            request with that key is still running. `folder_not_empty` (409):
            the folder still holds designs or folders. `builtin_folder`,
            `builtin_palette` (409): Print.App's own folders and palettes cannot
            be changed. `editor_not_supported` (409): page content can only be
            edited on accounts that use the new editor. `design_changed` (409):
            the design was saved elsewhere while the batch ran; read it again
            and retry. `payload_too_large` (413): a body or file over the limit.
            `unsupported_media_type` (415): send JSON. `ops_failed` (422): an
            operation in the batch failed, nothing was saved — see `details`.
            `internal_error` (500): retry; contact support with the `requestId`
            if it persists. `service_unavailable` (503): retry in a few seconds.
        message:
          type: string
        param:
          type: string
          description: The parameter or body field at fault, as a path (`pages[0].title`).
        details:
          type: array
          description: >-
            Every problem found, when there was more than one
            (`invalid_request`), or each operation's result (`ops_failed`).
          items:
            type: object
        requestId:
          type: string
          description: >-
            Also sent as the `x-request-id` header. Quote it when contacting
            support.
      examples:
        - error: true
          code: invalid_request
          message: limit must be an integer from 1 to 100.
          param: limit
          requestId: FZn-uhymjoEEJow=
    GatewayError:
      type: object
      properties:
        message:
          type: string
      description: Returned by the API gateway itself (429).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A secret key from Print.App admin → Domains → Secret keys, sent as
        `Authorization: Bearer sk_…`. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.