Skip to content

Load Character Template

GET
/api/creative/templates/{template_name}

Load a specific template by name.

template_name
required
Template Name
string

Successful Response

CharacterTemplateLoadResponse

Response containing a loaded template layout.

object
template
required
SheetLayout

Template layout data

object
pageTitle
required
Pagetitle

Sheet title

string
layoutGrid
required
SheetLayoutGrid

CSS Grid definition

object
template
required
Template

Grid template areas

Array<Array<string>>
columns
required
Columns

CSS grid-template-columns value

string
gap
Gap

CSS grid gap

string
default: 16px
components
required
Components

Layout components

Array<object>
SheetComponent

A single component in a character sheet layout.

object
id
required
Id

Unique component identifier

string
gridArea
required
Gridarea

CSS Grid area name

string
type
required
Type

Component type from the library

string
label
Any of:
string
fields
Any of:
Array<string>
stats
Any of:
Array<string>
placeholder
Any of:
string
rows
Any of:
integer
columns
Any of:
integer
columnHeaders
Any of:
Array<string>
modifierFormula
Any of:
string
Allowed values: dnd half fifth none
version
Version

Schema version

string
default: 1.0
createdAt
Any of:
string

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