Skip to content
Ishvana Ishvana Docs

Analyze File Path

POST
/api/creative/lore/analyze/file-path

Analyze a file on disk and return parsed metadata for preview. Does not create entries.

Request Body required

Section titled “Request Body required ”
LoreAnalyzeFileRequest

Request to analyze a file from disk without creating an entry (preview before import).

object
filePath
required
Filepath

Absolute path to the file on disk

string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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

422

Section titled “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