Get Completion

GET

/api/desktop/completion

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Compute completion data for the active project.

Responses

200

Successful Response

CompletionResponse

Completion response wrapper.

object

status

required

Status

Operation status

string

data

required

CompletionResponseData

Completion payload

object

completion

required

ProjectCompletionData

Project completion data

object

overallPercent

required

Overallpercent

Weighted overall %

number

<= 100

breakdown

required

Breakdown

Project-level breakdown

Array<object>

CompletionBreakdown

Completion percentage for a single dimension.

object

dimension

required

Dimension

Dimension key

string

Allowed values: outline-status word-count plot-resolution plant-payoff promise-fulfillment lore-coverage

label

required

Label

Human-readable label

string

percent

required

Percent

Completion %

number

<= 100

detail

required

Detail

E.g. ‘14 of 20 scenes done’

string

books

required

Books

Per-book completion

Array<object>

BookCompletion

Completion data for a single book or series node.

object

nodeId

required

Nodeid

Outline node UUID

string

title

required

Title

Book/series title

string

nodeType

required

Nodetype

Node type

string

Allowed values: series book

overallPercent

required

Overallpercent

Weighted overall %

number

<= 100

breakdown

required

Breakdown

Per-dimension details

Array<object>

CompletionBreakdown

Completion percentage for a single dimension.

object

dimension

required

Dimension

Dimension key

string

Allowed values: outline-status word-count plot-resolution plant-payoff promise-fulfillment lore-coverage

label

required

Label

Human-readable label

string

percent

required

Percent

Completion %

number

<= 100

detail

required

Detail

E.g. ‘14 of 20 scenes done’

string

children

required

Array<object> recursive

formula

required

CompletionFormulaConfig

Active formula config

object

dimensions

required

Dimensions

Per-dimension settings

object

key

additional properties

DimensionConfig

Configuration for a single completion dimension.

object

enabled

required

Enabled

Whether this dimension is included

boolean

weight

required

Weight

Relative weight (0-100)

integer

<= 100