Skip to content

Ingest File

POST
/api/creative/lore/ingest/file

Ingest a file as lore entries. Supports .md, .txt, .html, .doc, .docx, .pdf, .rtf files.

extract_entities
Extract Entities
boolean
default: true
Body_ingest_file_api_creative_lore_ingest_file_post
object
file
required
File
string

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

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