Skip to content

Ingest Vault

POST
/api/creative/lore/ingest/vault

Batch-ingest an Obsidian vault directory as lore entries.

Handles folder→category mapping, media asset upload to Visual Studio, and wikilink cross-reference resolution.

LoreVaultIngestRequest

Request to batch-ingest an Obsidian vault directory as lore entries.

object
vaultPath
required
Vaultpath

Path to Obsidian vault directory

string
>= 1 characters
categoryId
Any of:
string
extractEntities
Extractentities
boolean
default: true
preserveFolders
Preservefolders

Use vault folder structure as lore categories

boolean
default: true
convertWikilinks
Convertwikilinks

Convert [[wikilinks]] to lore entry cross-references

boolean
default: true
importAssets
Importassets

Upload media files to Visual Studio and link to entries

boolean
default: true
visualProjectId
Any of:
string
batchSize
Batchsize

Concurrent file processing batch size

integer
default: 10 >= 1 <= 50

Successful Response

LoreVaultIngestResponse

Extended response for vault ingestion with asset and cross-reference stats.

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
assetsUploaded
required
Assetsuploaded
integer
assetsLinked
required
Assetslinked
integer
wikilinksResolved
required
Wikilinksresolved
integer
categoriesCreated
required
Categoriescreated
integer
errors
required
Errors
Array<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