Skip to content
Ishvana Ishvana Docs

Get Book

GET
/api/creative/bookmaker/books/{book_id}

Get a single book by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
book_id
required
Book Id
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
project_id
required
Project Id
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Book

A book entity — persistent, re-exportable, linked to an outline tree.

object
id
required
Id
string
projectId
required
Projectid
string
outlineNodeId
required
Any of:
string
title
required
Title
string
subtitle
required
Subtitle
string
author
required
Author
string
isbn
required
Isbn
string
publisher
required
Publisher
string
copyrightText
required
Copyrighttext
string
description
required
Description
string
templateId
required
Templateid
string
Allowed values: fiction-novel ttrpg-rulebook art-book graphic-novel custom
platformPreset
required
Platformpreset
string
Allowed values: kdp-paperback kdp-hardcover drivethrurpg ingram-spark lulu custom
layoutConfig
required
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
themeConfig
required
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
sectionBreakAssetName
Sectionbreakassetname
string
""
dropCapStyle
Dropcapstyle
string
default: none
Allowed values: none standard ornate
frontMatter
required
FrontMatter

Front matter configuration.

object
titlePage
Titlepage
boolean
default: true
copyrightPage
Copyrightpage
boolean
default: true
dedication
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
tableOfContents
Tableofcontents
boolean
default: true
epigraph
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
foreword
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
preface
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
backMatter
required
BackMatter

Back matter configuration — includes lore-sourced appendices.

object
appendices
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
glossary
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
indexSection
Indexsection
boolean
authorBio
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
alsoBy
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
contentSources
required
ContentSources

What the Book Maker pulls from other Ishvana systems during compilation.

object
loreAppendices
Loreappendices
Array<object>
LoreAppendixSource

Configuration for a lore-sourced appendix (e.g., Cast of Characters).

object
entryType
required
Entrytype
string
filterStatus
Filterstatus
string
default: published
label
Label
string
""
includePortraits
Includeportraits
boolean
characterSheets
CharacterSheetSource

Configuration for character sheet stat blocks in the book.

object
enabled
Enabled
boolean
sheetIds
Sheetids
Array<string>
renderAs
Renderas
string
default: stat-block
Allowed values: stat-block full-page
includeBlankSheet
Includeblanksheet
boolean
interiorArt
Interiorart
Array<object>
InteriorArtPlacement

Placement of a Visual Studio asset in the book.

object
assetId
required
Assetid
string
placement
Placement
string
default: chapter-start
Allowed values: chapter-start full-page inline half-page
targetNodeId
Any of:
string
hawkenGenerated
HawkenGeneratedContent

Hawken AI-generated content for the book.

object
backCoverBlurb
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
chapterSummaries
MatterSection

A toggleable section of front or back matter.

object
enabled
Enabled
boolean
content
Content
string
""
documentId
Any of:
string
proseGuardGate
ProseGuardGateConfig

ProseGuard pre-publish quality gate configuration.

object
enabled
Enabled
boolean
default: true
blockOnErrors
Blockonerrors
boolean
coverAssetId
required
Any of:
string
editionType
required
Editiontype
string
Allowed values: standard player gm
pageAdjustments
Pageadjustments
Array<object>
PageAdjustment

A per-node layout adjustment applied during compilation.

object
id
required
Id
string
nodeId
required
Nodeid
string
adjustmentType
required
Adjustmenttype
string
Allowed values: page-break-before column-break-before spacing-before spacing-after keep-together
value
Value
string
""
note
Note
string
""
lastCompiledAt
required
Any of:
integer
lastCompiledPath
required
Any of:
string
status
required
Status
string
Allowed values: draft compiling compiled error
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

422

Section titled “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