Skip to content
Ishvana Ishvana Docs

Roll Detailed

POST
/api/creative/mechanics/analysis/roll

Roll dice and return individual results with band classification.

Request Body required

Section titled “Request Body required ”
DetailedRollRequest

Request for a detailed dice roll with individual die results.

object
poolSize
required
Poolsize
integer
>= 1 <= 50
outcomeMapping
required
DiceOutcomeMapping

Defines how individual die faces map to categorical outcomes.

For a d10 pool system: faces 1-10 map to bands like Critical Success, Advantage, Neutral, Consequence, Critical Failure — each with a weight that determines net outcome when advantages and consequences cancel.

object
dieFaces
required
Diefaces
integer
>= 2 <= 100
bands
required
Bands
Array<object>
>= 1 items
DiceOutcomeBand

A range of die face values with a categorical meaning and weight.

Example: on a d10, faces 8-9 are “Advantage” with weight +1.

object
name
required
Name
string
>= 1 characters <= 50 characters
minValue
required
Minvalue
integer
>= 1
maxValue
required
Maxvalue
integer
>= 1
weight
Weight
integer
0
color
Color
string
default: #6b7280

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

DetailedRollResponse

Response with individual die results and net weight.

object
dice
required
Dice
Array<object>
DieResult

A single die face result with its outcome band classification.

object
face
required
Face
integer
bandName
required
Bandname
string
weight
required
Weight
integer
color
required
Color
string
netWeight
required
Netweight
integer
poolSize
required
Poolsize
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