Ingest Text

POST

/api/creative/lore/ingest

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Ingest raw text as lore entries.

Parses text using format-aware parsers, creates individual entries, and extracts entities from each. Override fields from the preview step (title, entry_type, tags, excerpt, summary) take precedence over parser-extracted values.

Request Body ^required

LoreIngestRequest

Request to ingest raw text as lore entries.

object

text

required

Text

Raw text to ingest

string

>= 1 characters

sourceFormat

LoreSourceFormat

Source formats for ingested lore documents.

string

default: markdown

Allowed values: markdown plain_text html obsidian world_anvil docx pdf rtf

sourceName

Any of:

string

string

null

null

categoryId

Any of:

string

string

null

null

autoCategorize

Autocategorize

boolean

extractEntities

Extractentities

boolean

default: true

title

Any of:

string

string

null

null

entryType

Any of:

string

string

null

null

tags

Any of:

Array<string>

Array<string>

null

null

portraitAssetId

Any of:

string

string

null

null

excerpt

Any of:

string

string

null

null

summary

Any of:

string

string

null

null

headingLevel

Headinglevel

Primary heading level for section extraction

integer

default: 2 >= 1 <= 5

headingLevels

Any of:

Array<integer>

Array<integer>

null

null

sections

Any of:

Array<object>

Array<object>

LoreSection

A structured section within a lore entry.

object

key

required

Key

Section identifier, e.g. ‘origins’

string

>= 1 characters

label

required

Label

Display label, e.g. ‘Origins’

string

>= 1 characters

content

Content

Markdown content

string

""

status

SectionStatus

In-world knowledge status

string

default: unknown

Allowed values: known unknown secret

sortOrder

Sortorder

Display order

integer

0

null

null

Responses

200

Successful Response

LoreIngestResponse

Response for lore ingestion.

object

entriesCreated

required

Entriescreated

integer

entitiesExtracted

required

Entitiesextracted

integer

results

required

Results

Array<object>

LoreIngestResult

Result of a single ingested entry.

object

entryId

required

Entryid

string

title

required

Title

string

wordCount

required

Wordcount

integer

entitiesFound

required

Entitiesfound

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