Skip to content

Analyze Text

POST
/api/creative/lore/analyze

Analyze raw text and return parsed metadata for preview. Does not create entries.

LoreAnalyzeRequest

Request to analyze text without creating an entry (preview before import).

object
text
required
Text

Raw text to analyze

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

Successful Response

LoreAnalyzeResponse

Parsed metadata from analyzed text, for preview before import.

object
title
required
Title
string
content
required
Content
string
entryType
Entrytype
string
default: article
tags
Tags
Array<string>
excerpt
Excerpt
string
""
summary
Summary
string
""
portraitAssetId
Any of:
string
wikilinks
Wikilinks
Array<string>
metadata
Metadata
object
key
additional properties
string
detectedFormat
required
Detectedformat
string
suggestedCategoryName
Suggestedcategoryname

Suggested category name from content/type analysis

string
""
detectedHeadingLevel
Detectedheadinglevel

Auto-detected heading level for sections

integer
default: 2
wordCount
required
Wordcount
integer

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