Skip to content

Save Character Sheet

POST
/api/creative/save-sheet

Save a filled character sheet.

CharacterSheetSaveRequest

Request to save a filled character sheet.

object
name
required
Name

Character name

string
templateName
Templatename

Source template name

string
""
layout
required
SheetLayout

Sheet layout

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
data
required
Data

Filled-in field values

object
key
additional properties
any
id
Any of:
string
entryId
Any of:
string

Successful Response

CharacterSheetSaveResponse

Response confirming a character sheet save.

object
id
required
Id

Saved sheet ID

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