Get Scene Context Route

GET

/api/writing/documents/{document_id}/scene-context

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Get narrative context for a document/scene.

Returns plot beats, characters, character knowledge, timeline events, and locations relevant to this document’s linked outline node.

Parameters

Path Parameters

document_id

required

Document Id

string

Query Parameters

node_id

Any of:

string

string

null

null

Responses

200

Successful Response

SceneContext

Full narrative context for a document/scene.

object

documentId

required

Documentid

string

outlineNodeId

Outlinenodeid

string

""

outlineNodeTitle

Outlinenodetitle

string

""

plotBeats

Plotbeats

Array<object>

ScenePlotBeat

A plot point active in this scene.

object

pointId

required

Pointid

string

plotlineId

required

Plotlineid

string

plotlineTitle

required

Plotlinetitle

string

plotlineColor

Plotlinecolor

string

""

pointTitle

required

Pointtitle

string

pointType

required

Pointtype

string

intensity

required

Intensity

integer

status

required

Status

string

characters

Characters

Array<object>

SceneCharacter

A character or entity present in this scene.

object

loreEntryId

required

Loreentryid

string

name

required

Name

string

entryType

required

Entrytype

string

role

Role

string

""

portraitUrl

Portraiturl

string

""

knowledge

Knowledge

Array<object>

SceneKnowledgeFact

A fact a character knows (or doesn’t) at this scene.

object

characterId

required

Characterid

string

characterName

required

Charactername

string

fact

required

Fact

string

factType

Facttype

string

""

isKnown

Isknown

boolean

default: true

timelineEvents

Timelineevents

Array<object>

SceneTimelineEvent

A timeline event related to this scene’s plot beats.

object

eventId

required

Eventid

string

timelineId

required

Timelineid

string

title

required

Title

string

dateDisplay

Datedisplay

string

""

locations

Locations

Array<object>

SceneLocation

A location relevant to this scene.

object

loreEntryId

required

Loreentryid

string

name

required

Name

string

mapPinId

Mappinid

string

""

mapId

Mapid

string

""

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