Get Knowledge State

GET

/api/writing/knowledge/character/{entity_id}/state

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Parameters

Path Parameters

entity_id

required

Entity Id

string

>= 1 characters

Query Parameters

at_node_id

required

At Node Id

string

>= 1 characters

project_id

required

Project Id

string

>= 1 characters

Responses

200

Successful Response

KnowledgeStateResponse

object

characterEntityId

required

Characterentityid

string

characterName

required

Charactername

string

atNodeId

required

Atnodeid

string

atNodeTitle

required

Atnodetitle

string

atNodeOrdinal

required

Atnodeordinal

integer

knownFacts

Knownfacts

Array<object>

KnowledgeFactResponse

object

id

required

Id

string

projectId

required

Projectid

string

characterEntityId

required

Characterentityid

string

characterName

required

Charactername

string

factType

required

Facttype

string

Allowed values: lore_entry lore_section custom

loreEntryId

required

Any of:

string

string

null

null

loreEntryTitle

required

Any of:

string

string

null

null

loreSectionKey

required

Any of:

string

string

null

null

loreSectionLabel

required

Any of:

string

string

null

null

customFact

required

Any of:

string

string

null

null

learnedAtNodeId

required

Any of:

string

string

null

null

learnedAtNodeTitle

required

Any of:

string

string

null

null

learnedAtOrdinal

required

Any of:

integer

integer

null

null

knownFromStart

required

Knownfromstart

boolean

notes

required

Notes

string

createdAt

required

Createdat

integer

modifiedAt

required

Modifiedat

integer

unknownFacts

Unknownfacts

Array<object>

KnowledgeFactResponse

object

id

required

Id

string

projectId

required

Projectid

string

characterEntityId

required

Characterentityid

string

characterName

required

Charactername

string

factType

required

Facttype

string

Allowed values: lore_entry lore_section custom

loreEntryId

required

Any of:

string

string

null

null

loreEntryTitle

required

Any of:

string

string

null

null

loreSectionKey

required

Any of:

string

string

null

null

loreSectionLabel

required

Any of:

string

string

null

null

customFact

required

Any of:

string

string

null

null

learnedAtNodeId

required

Any of:

string

string

null

null

learnedAtNodeTitle

required

Any of:

string

string

null

null

learnedAtOrdinal

required

Any of:

integer

integer

null

null

knownFromStart

required

Knownfromstart

boolean

notes

required

Notes

string

createdAt

required

Createdat

integer

modifiedAt

required

Modifiedat

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