Skip to content

Save Ability

POST
/api/creative/mechanics/ability-workshop/save

Persist an ability to the abilities table.

SaveAbilityRequest
object
projectId
required
Projectid
string
rulesetRef
required
Rulesetref
string
magicSystemRef
Magicsystemref
string
""
components
required
AbilityComponents

Full component tree for one ability.

object
target
TargetComponent
object
kind
Kind
string
default: single_enemy
Allowed values: self single_ally single_enemy area_sphere area_cube area_line area_cone chain touch
range
RangeComponent
object
value
Value
integer
default: 30 <= 100000
unit
Unit
string
default: ft
scalesWithLevel
Scaleswithlevel
boolean
special
Special
string
""
cost
CostComponent
object
resource
Resource
string
default: action
amount
Amount
integer
default: 1 <= 1000
alternate
Alternate
string
""
effect
EffectComponent
object
kind
Kind
string
default: damage
Allowed values: damage heal control buff debuff summon movement utility
magnitude
Magnitude
string
default: 1d6
scalingFormulaRef
Scalingformularef
string
""
elementalTag
Elementaltag
string
""
secondary
Secondary
Array<string>
duration
DurationComponent
object
kind
Kind
string
default: instant
Allowed values: instant 1_round n_rounds scene stance concentration permanent
rounds
Rounds
integer
0
repeatTrigger
Repeattrigger
string
""
save
SaveComponent
object
stat
Stat
string
""
dcFormula
Dcformula
string
""
partialEffect
Partialeffect
string
default: no_effect
Allowed values: no_effect half specified_reduction
specifiedReduction
Specifiedreduction
string
""
tags
TagsComponent

Boolean flags for ability metadata tags.

object
stealth
Stealth
boolean
loud
Loud
boolean
visible
Visible
boolean
ritual
Ritual
boolean
materialComponent
Materialcomponent
boolean
verbal
Verbal
boolean
somatic
Somatic
boolean
reactionTrigger
Reactiontrigger
boolean
concentration
Concentration
boolean
areaSelectable
Areaselectable
boolean
lineOfSightRequired
Lineofsightrequired
boolean
default: true
metadata
AbilityMetadata
object
name
Name
string
""
flavorDescription
Flavordescription
string
""
sourceArchetype
Sourcearchetype
string
""
schoolOrTradition
Schoolortradition
string
""
rarity
Rarity
string
default: common
Allowed values: common uncommon rare legendary
tier
Tier
integer
default: 1 <= 10
name
required
Name
string
description
required
Description
string
powerLevel
Powerlevel
number
0
tier
Tier
integer
default: 1
rarity
Rarity
string
default: common
Allowed values: common uncommon rare legendary
sourceTemplateId
Sourcetemplateid
string
""

Successful Response

Response Save Ability Api Creative Mechanics Ability Workshop Save Post
object
key
additional properties
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