Skip to content

Get View Data

GET
/api/writing/outline/view-data

Get enriched outline data with legend refs for grid/reading/matrix views.

project_id
required
Project Id
string
>= 1 characters

Successful Response

OutlineViewDataResponse

Full enriched outline data for grid/reading/matrix views.

object
nodes
required
Nodes
Array<object>
OutlineNodeWithLegendRefs

Outline node enriched with resolved Legend references for view modes.

object
node
required
OutlineNode

Single outline node in the book hierarchy.

object
id
required
Id
string
projectId
required
Projectid
string
parentId
required
Any of:
string
title
required
Title
string
nodeType
required
Nodetype
string
Allowed values: series book part act chapter scene beat
summary
required
Summary
string
notes
required
Notes
string
sortOrder
required
Sortorder
integer
documentId
required
Any of:
string
wordCountTarget
required
Any of:
integer
status
required
Status
string
Allowed values: draft in_progress revision done
povType
Any of:
string
Allowed values: first_person second_person third_limited third_omniscient third_objective multiple_first deep_third stream_of_consciousness unreliable
povEntityId
Any of:
string
sceneType
Any of:
string
Allowed values: scene sequel hybrid flashback vision dream
sceneOutcome
Any of:
string
Allowed values: success failure partial disaster yes_but no_and pyrrhic unexpected
locationEntityId
Any of:
string
timeMarkerEventId
Any of:
string
timeMarkerText
Any of:
string
knowledgeState
Any of:
SceneKnowledgeState

Knowledge state for a scene, keyed by participant lore_entries.id.

Participants absent from the map are treated as having empty known / unknown sets — the map is only required to carry non-empty state.

object
participants
Participants
object
key
additional properties
ParticipantKnowledge

Per-participant fact set — what a character knows (and does not know) at the start of a scene.

M3 stores facts as free-text strings. M4 will upgrade them to {id, text} references when the contradiction engine formalizes a fact registry; the shape evolves forward-compatibly via data migration, not a schema rewrite.

object
knownFacts
Knownfacts
Array<string>
unknownFacts
Unknownfacts
Array<string>
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
povEntityName
Any of:
string
povEntityType
Any of:
string
legendRefs
Legendrefs
Array<object>
OutlineNodeLegendRef

Legend entry reference attached to an outline node (scene/chapter).

object
id
required
Id
string
nodeId
required
Nodeid
string
legendEntryId
required
Legendentryid
string
title
required
Title
string
entryType
required
Entrytype
string
source
required
Source
string
Allowed values: manual auto
loreEntryId
Any of:
string
wordCount
Wordcount
integer
0
allLegendRefs
required
Alllegendrefs
Array<object>
OutlineNodeLegendRef

Legend entry reference attached to an outline node (scene/chapter).

object
id
required
Id
string
nodeId
required
Nodeid
string
legendEntryId
required
Legendentryid
string
title
required
Title
string
entryType
required
Entrytype
string
source
required
Source
string
Allowed values: manual auto
loreEntryId
Any of:
string

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