Skip to content

Create Annotation

POST

/api/creative/plot/annotations

DivinityEngine - Local development
DivinityEngine - Localhost alternative

Create a plot annotation on a document.

Request Body^required

AnnotationCreateRequest

Create a plot annotation.

object

documentId

required

Documentid

Document to annotate

string

>= 1 characters

plotPointId

Any of:

string
null

string

plotlineId

Any of:

string
null

string

plantId

Any of:

string
null

string

anchorParagraphIndex

required

Anchorparagraphindex

Paragraph index

integer

anchorText

Anchortext

Nearby text

string

""

noteText

required

Notetext

Note content

string

>= 1 characters

noteType

Notetype

Note type

string

default: general

Allowed values: general tap_reminder foreshadowing setup payoff continuity

Responses

200

Successful Response

AnnotationResponse

Single annotation response.

object

status

required

Status

Operation status

string

data

required

PlotAnnotation

The annotation

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
null

string

plotlineId

Any of:

string
null

string

resolvedPlotlineId

Any of:

string
null

string

plantId

Any of:

string
null

string

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
null

string

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

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