Get Template

GET

/api/creative/bookmaker/templates/{template_id}

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Get details for a specific book template.

Parameters

Path Parameters

template_id

required

Template Id

string

>= 1 characters

Responses

200

Successful Response

TemplateInfo

Metadata about an available book template.

object

id

required

Id

string

Allowed values: fiction-novel ttrpg-rulebook art-book graphic-novel custom

name

required

Name

string

description

required

Description

string

previewImage

Any of:

string

string

null

null

defaultLayout

LayoutConfig

Physical page layout — trim size, margins, columns, headers/footers.

object

trimWidth

Trimwidth

number

default: 6 > 0 <= 24

trimHeight

Trimheight

number

default: 9 > 0 <= 24

marginTop

Margintop

number

default: 0.75 <= 6

marginBottom

Marginbottom

number

default: 0.75 <= 6

marginInner

Margininner

number

default: 0.875 <= 6

marginOuter

Marginouter

number

default: 0.625 <= 6

bleed

Bleed

number

default: 0.125 <= 1

columnsPerPage

Columnsperpage

integer

default: 1 >= 1 <= 6

columnGap

Columngap

number

default: 0.25 <= 3

chapterStartPage

Chapterstartpage

string

default: recto

Allowed values: any recto verso

headerStyle

Headerstyle

string

default: book-title-alternating

Allowed values: none book-title-alternating chapter-title custom

pageNumberStyle

Pagenumberstyle

string

default: bottom-center

Allowed values: none bottom-center bottom-outside top-outside

colorProfile

Colorprofile

string

default: cmyk

Allowed values: cmyk rgb

defaultTheme

ThemeConfig

Visual skin for the book — colors, fonts, ornaments. World-agnostic.

object

colors

ThemeColors

Color palette for the book theme — fully customizable per world.

object

primary

Primary

string

default: #d4885c /^#[0-9a-fA-F]{3,8}$/

secondary

Secondary

string

default: #2a1f1a /^#[0-9a-fA-F]{3,8}$/

accent

Accent

string

default: #8b6914 /^#[0-9a-fA-F]{3,8}$/

pageBackground

Pagebackground

string

default: #faf6f0 /^#[0-9a-fA-F]{3,8}$/

textPrimary

Textprimary

string

default: #1a1a1e /^#[0-9a-fA-F]{3,8}$/

textSecondary

Textsecondary

string

default: #4a4540 /^#[0-9a-fA-F]{3,8}$/

statBlockBorder

Statblockborder

string

default: #8b6914 /^#[0-9a-fA-F]{3,8}$/

statBlockBackground

Statblockbackground

string

default: #f5efe6 /^#[0-9a-fA-F]{3,8}$/

sidebarBackground

Sidebarbackground

string

default: #ede5d8 /^#[0-9a-fA-F]{3,8}$/

tableHeader

Tableheader

string

default: #2a1f1a /^#[0-9a-fA-F]{3,8}$/

tableStripe

Tablestripe

string

default: #f5f0ea /^#[0-9a-fA-F]{3,8}$/

fonts

ThemeFonts

Font selections for the book theme.

object

body

Body

string

default: Libertinus Serif /^[A-Za-z0-9 _-]+$/

bodySize

Bodysize

integer

default: 11 >= 6 <= 72

heading

Heading

string

default: Linux Biolinum G /^[A-Za-z0-9 _-]+$/

headingSize

Headingsize

integer

default: 18 >= 6 <= 120

statBlock

Statblock

string

default: Alegreya Sans /^[A-Za-z0-9 _-]+$/

mono

Mono

string

default: IBM Plex Mono /^[A-Za-z0-9 _-]+$/

lineSpacing

Linespacing

number

default: 1.4 > 0 <= 4

ornaments

ThemeOrnaments

Decorative elements for the book theme.

object

chapterDivider

Chapterdivider

string

default: simple-rule

Allowed values: none simple-rule three-asterisks ornate-divider custom

sectionBreak

Sectionbreak

string

default: three-asterisks

Allowed values: none simple-rule three-asterisks ornate-divider custom

sectionBreakAssetUrl

Any of:

string

string

null

null

sectionBreakAssetName

Sectionbreakassetname

string

""

dropCapStyle

Dropcapstyle

string

default: none

Allowed values: none standard ornate

supportedFeatures

Supportedfeatures

Array<string>

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object