List Project Annotations

GET

/api/creative/plot/annotations/project/active

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

List all plot annotations for the active project.

Responses

200

Successful Response

AnnotationListResponse

Annotation list response.

object

status

required

Status

Operation status

string

data

required

AnnotationListData

Annotations payload

object

annotations

Annotations

Array<object>

PlotAnnotation

A non-exported author note anchored to a paragraph in a document.

object

id

required

Id

Annotation UUID

string

documentId

required

Documentid

Document this annotation belongs to

string

documentTitle

Documenttitle

Title of the linked document

string

""

plotPointId

Any of:

string

string

null

null

plotlineId

Any of:

string

string

null

null

resolvedPlotlineId

Any of:

string

string

null

null

plantId

Any of:

string

string

null

null

anchorParagraphIndex

required

Anchorparagraphindex

Paragraph index (0-based)

integer

anchorText

Anchortext

Nearby text for re-anchoring

string

""

noteText

required

Notetext

The annotation content

string

noteType

Notetype

Classification

string

default: general

Allowed values: general tap_reminder foreshadowing setup payoff continuity

status

Status

Annotation lifecycle status

string

default: active

Allowed values: active resolved converted

plotlineTitle

Plotlinetitle

Title of linked plotline

string

""

plotlineColor

Plotlinecolor

Color of linked plotline

string

""

pointTitle

Pointtitle

Title of linked plot point

string

""

pointType

Pointtype

Type of linked plot point

string

""

beatSheetPositionName

Beatsheetpositionname

Beat sheet position name

string

""

plantTitle

Planttitle

Title of linked plant

string

""

plantStatus

Plantstatus

Status of linked plant

string

""

entityNames

Entitynames

Entities at linked point

Array<string>

pointEntities

Pointentities

Linked lore entities at the plot point

Array<object>

PlotlineEntity

Entity tagged to a plotline or plot point.

object

id

required

Id

Link UUID

string

loreEntryId

required

Loreentryid

Lore entry

string

role

Role

Role in plotline

string

""

title

Title

Entity title (denormalized)

string

""

inheritedFrom

Any of:

string

string

null

null

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

total

required

Total

Total count

integer