lilbee (0.6.90b420.dev725)

Download OpenAPI specification:

Local knowledge base REST API

HealthRoute

Responses

Response samples

200

Content type

application/json

{"status": "string",
"version": "string",
"chat_ready": false,
"chat_status": "ready",
"chat_error": "string",
"chat_ctx": 0
}

WarmStreamRoute

Responses

Response samples

200

Content type

application/json

null

StatusRoute

Responses

Response samples

200

Content type

application/json

{"command": "status",
"config": {"documents_dir": "string",
"data_dir": "string",
"chat_model": "string",
"embedding_model": "string",
"vision_model": "",
"reranker_model": "",
"enable_ocr": true
},
"sources": [{"filename": "string",
"file_hash": "string",
"chunk_count": 0,
"ingested_at": "string"
}
],
"total_chunks": 0,
"entities": {"types": ["string"
],
"rows": 0
}
}

ShutdownRoute

Responses

Response samples

202

Content type

application/json

{"status": "shutting_down"
}

ConfigRoute

Responses

Response samples

200

Content type

application/json

{ }

ConfigUpdateRoute

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
400

Content type

application/json

{"updated": ["string"
],
"reindex_required": true
}

ConfigDefaultsRoute

Responses

Response samples

200

Content type

application/json

{ }

SourceContentRoute

query Parameters

source required	string
raw	boolean Default: false

Responses

Response samples

200
400

Content type

application/json

Example

SourceContentResponse

{"markdown": "string",
"content_type": "string",
"title": "string"
}

SearchRoute

query Parameters

q required	string
top_k	integer [ 1 .. 100 ] Default: 5
	string or null

Responses

Response samples

200
400

Content type

application/json

[{"source": "string",
"content_type": "string",
"excerpts": [{"content": "string",
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"relevance": 0
}
],
"best_relevance": 0,
"vault_path": "string"
}
]

AskRoute

Request Body schema: application/json
required

question required	string
top_k	integer [ 0 .. 100 ] Default: 0
	object or null
	ChunkType (string) or null

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"top_k": 0,
"options": {"property1": null,
"property2": null
},
"chunk_type": "raw"
}

Response samples

201
400

Content type

application/json

{"answer": "string",
"sources": [{"source": "string",
"content_type": "string",
"chunk": "string",
"distance": 0,
"relevance_score": 0,
"rerank_score": 0,
"score": 0,
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"chunk_index": 0,
"vault_path": "string"
}
],
"cited_sources": [{"source": "string",
"content_type": "string",
"chunk": "string",
"distance": 0,
"relevance_score": 0,
"rerank_score": 0,
"score": 0,
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"chunk_index": 0,
"vault_path": "string"
}
],
"compaction": {"summary": "string",
"condensed": 0,
"stranded": 0
}
}

AskStreamRoute

Request Body schema: application/json
required

question required	string
top_k	integer [ 0 .. 100 ] Default: 0
	object or null
	ChunkType (string) or null

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"top_k": 0,
"options": {"property1": null,
"property2": null
},
"chunk_type": "raw"
}

Response samples

201
400

Content type

application/json

null

ChatRoute

Request Body schema: application/json
required

question required	string
history	any Default: []
	integer or null <= 100
	object or null
	ChunkType (string) or null
summary	string Default: ""
	string or null

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"history": [ ],
"top_k": 0,
"options": {"property1": null,
"property2": null
},
"chunk_type": "raw",
"summary": "",
"session_id": "string"
}

Response samples

201
400

Content type

application/json

{"answer": "string",
"sources": [{"source": "string",
"content_type": "string",
"chunk": "string",
"distance": 0,
"relevance_score": 0,
"rerank_score": 0,
"score": 0,
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"chunk_index": 0,
"vault_path": "string"
}
],
"cited_sources": [{"source": "string",
"content_type": "string",
"chunk": "string",
"distance": 0,
"relevance_score": 0,
"rerank_score": 0,
"score": 0,
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"chunk_index": 0,
"vault_path": "string"
}
],
"compaction": {"summary": "string",
"condensed": 0,
"stranded": 0
}
}

ChatStreamRoute

Request Body schema: application/json
required

question required	string
history	any Default: []
	integer or null <= 100
	object or null
	ChunkType (string) or null
summary	string Default: ""
	string or null

Responses

Request samples

Payload

Content type

application/json

{"question": "string",
"history": [ ],
"top_k": 0,
"options": {"property1": null,
"property2": null
},
"chunk_type": "raw",
"summary": "",
"session_id": "string"
}

Response samples

201
400

Content type

application/json

null

ListModelsEndpoint

Responses

Response samples

200

Content type

application/json

null

ChatCompletionsEndpoint

Request Body schema: application/json
required

model required	string non-empty
required	Array of objects (CompletionsMessage) non-empty
	Array of CompletionsTool (objects) or null
	ToolChoiceMode (string) or CompletionsNamedToolChoice (object) or null
	number or null <= 2
	number or null <= 1
	integer or null >= 1
	integer or null >= 1
	integer or null
	number or null [ -2 .. 2 ]
	number or null [ -2 .. 2 ]
	integer or null >= 1
	string or Array of strings or null
stream	boolean Default: false
	StreamOptions (object) or null

Responses

Request samples

Payload

Content type

application/json

{"model": "string",
"messages": [{"role": "system",
"content": "string",
"name": "string",
"tool_calls": [{"id": "string",
"type": "function",
"function": {"name": "string",
"arguments": "{}"
}
}
],
"tool_call_id": "string"
}
],
"tools": [{"type": "function",
"function": {"name": "string",
"description": "string",
"parameters": {"property1": null,
"property2": null
}
}
}
],
"tool_choice": "auto",
"temperature": 0,
"top_p": 0,
"top_k": 0,
"max_tokens": 0,
"seed": 0,
"frequency_penalty": 0,
"presence_penalty": 0,
"n": 0,
"stop": "string",
"stream": false,
"stream_options": {"include_usage": false
}
}

Response samples

200
400

Content type

application/json

null

SyncRoute

Request Body schema: application/json
required

One of

	boolean or null
force_rebuild	boolean Default: false
retry_skipped	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

Example

SyncRequest

{"enable_ocr": true,
"force_rebuild": false,
"retry_skipped": false
}

Response samples

201
400

Content type

application/json

null

AddRoute

Request Body schema: application/json
required

paths required	Array of strings
force	boolean Default: false
	boolean or null
	number or null

Responses

Request samples

Payload

Content type

application/json

{"paths": ["string"
],
"force": false,
"enable_ocr": true,
"ocr_timeout": 0
}

Response samples

201
400

Content type

application/json

null

AddUploadRoute

Request Body schema: multipart/form-data
required

files

Array of strings <binary> [ items <binary > ]

Responses

Response samples

201
400

Content type

application/json

null

ModelsListRoute

Responses

Response samples

200

Content type

application/json

{"chat": {"active": "string",
"catalog": [{"name": "string",
"size_gb": 0,
"min_ram_gb": 0,
"description": "string",
"installed": true
}
],
"installed": ["string"
]
},
"embedding": {"active": "string",
"catalog": [{"name": "string",
"size_gb": 0,
"min_ram_gb": 0,
"description": "string",
"installed": true
}
],
"installed": ["string"
]
},
"vision": {"active": "string",
"catalog": [{"name": "string",
"size_gb": 0,
"min_ram_gb": 0,
"description": "string",
"installed": true
}
],
"installed": ["string"
]
},
"reranker": {"active": "string",
"catalog": [{"name": "string",
"size_gb": 0,
"min_ram_gb": 0,
"description": "string",
"installed": true
}
],
"installed": ["string"
]
}
}

ModelsExternalRoute

Responses

Response samples

200

Content type

application/json

{"models": ["string"
],
"error": "string"
}

ModelsSetChatRoute

Request Body schema: application/json
required

model

required

string

Responses

Request samples

Payload

Content type

application/json

{"model": "string"
}

Response samples

200
400

Content type

application/json

{"model": "string",
"reindex_required": false
}

ModelsSetEmbeddingRoute

Request Body schema: application/json
required

model

required

string

Responses

Request samples

Payload

Content type

application/json

{"model": "string"
}

Response samples

200
400

Content type

application/json

{"model": "string",
"reindex_required": false
}

ModelsSetVisionRoute

Request Body schema: application/json
required

model

required

string

Responses

Request samples

Payload

Content type

application/json

{"model": "string"
}

Response samples

200
400

Content type

application/json

{"model": "string",
"reindex_required": false
}

ModelsSetRerankerRoute

Request Body schema: application/json
required

model

required

string

Responses

Request samples

Payload

Content type

application/json

{"model": "string"
}

Response samples

200
400

Content type

application/json

{"model": "string",
"reindex_required": false
}

ModelsCatalogRoute

query Parameters

	string or null
search	string Default: ""
	string or null
	boolean or null
	boolean or null
sort	string Default: "featured"
limit	integer [ 1 .. 1000 ] Default: 20
offset	integer >= 0 Default: 0

Responses

Response samples

200
400

Content type

application/json

{"total": 0,
"limit": 0,
"offset": 0,
"models": [{"hf_repo": "string",
"gguf_filename": "string",
"task": "chat",
"display_name": "string",
"param_count": "string",
"size_gb": 0,
"min_ram_gb": 0,
"description": "string",
"quality_tier": "string",
"featured": true,
"downloads": 0,
"installed": true,
"source": "native",
"fit": "fits",
"size_variants": [ ],
"architecture": "",
"compat": "supported",
"provider": "",
"key_status": "ready"
}
],
"has_more": false
}

ModelsInstalledRoute

Responses

Response samples

200

Content type

application/json

{"models": [{"name": "string",
"source": "native"
}
]
}

ModelsPullRoute

Request Body schema: application/json
required

model required	string
source	string Default: "native"
allow_unsupported	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"model": "string",
"source": "native",
"allow_unsupported": false
}

Response samples

201
400

Content type

application/json

null

ModelsShowRoute

Request Body schema: application/json
required

model

required

string

Responses

Request samples

Payload

Content type

application/json

{"model": "string"
}

Response samples

201
400

Content type

application/json

{ }

ModelsDeleteRoute

path Parameters

model

required

string

query Parameters

source

string

Default: "native"

Responses

Response samples

200
400

Content type

application/json

{"deleted": true,
"model": "string",
"freed_gb": 0
}

DocumentsListRoute

query Parameters

search	string Default: ""
limit	integer [ 1 .. 1000 ] Default: 50
offset	integer >= 0 Default: 0

Responses

Response samples

200
400

Content type

application/json

{"documents": [{"filename": "string",
"chunk_count": 0,
"ingested_at": ""
}
],
"total": 0,
"limit": 0,
"offset": 0,
"has_more": false
}

DocumentsRemoveRoute

Request Body schema: application/json
required

names required	Array of strings <= 100 items
delete_files	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"names": ["string"
],
"delete_files": false
}

Response samples

201
400

Content type

application/json

{"removed": ["string"
],
"not_found": ["string"
]
}

MemoriesListRoute

Responses

Response samples

200

Content type

application/json

{"memories": [{"id": "string",
"kind": "preference",
"shared": true,
"text": "string"
}
]
}

MemoriesRememberRoute

Request Body schema: application/json
required

text required	string
kind	string (MemoryKind) Enum: "preference" "fact" Whether a memory is an always-injected preference or a similarity-recalled fact.
shared	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"kind": "preference",
"shared": false
}

Response samples

201
400

Content type

application/json

{"id": "string",
"kind": "preference"
}

MemoriesRemoveRoute

path Parameters

memory_id

required

string

Responses

Response samples

200
400

Content type

application/json

{"id": "string",
"deleted": true
}

MemoriesUpdateRoute

path Parameters

memory_id

required

string

Request Body schema: application/json
required

shared

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"shared": true
}

Response samples

200
400

Content type

application/json

{"id": "string",
"updated": true
}

SessionsListRoute

Responses

Response samples

200

Content type

application/json

{"sessions": [{"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
}
]
}

SessionCreateRoute

Request Body schema: application/json
required

model_ref required	string
scope required	string

Responses

Request samples

Payload

Content type

application/json

{"model_ref": "string",
"scope": "string"
}

Response samples

201
400

Content type

application/json

{"meta": {"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
},
"messages": [{"role": "user",
"content": "string",
"sources": ["string"
],
"ts": "string"
}
],
"summary": ""
}

SessionGetRoute

path Parameters

session_id

required

string

Responses

Response samples

200
400

Content type

application/json

{"meta": {"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
},
"messages": [{"role": "user",
"content": "string",
"sources": ["string"
],
"ts": "string"
}
],
"summary": ""
}

SessionDeleteRoute

path Parameters

session_id

required

string

Responses

Response samples

200
400

Content type

application/json

{"id": "string",
"deleted": true
}

SessionRenameRoute

path Parameters

session_id

required

string

Request Body schema: application/json
required

title

required

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Response samples

200
400

Content type

application/json

{"id": "string",
"title": "string"
}

SessionAddMessageRoute

path Parameters

session_id

required

string

Request Body schema: application/json
required

role required	string (MessageRole) Enum: "user" "assistant" Author of a chat message.
content required	string
sources	Array of strings Default: []

Responses

Request samples

Payload

Content type

application/json

{"role": "user",
"content": "string",
"sources": [ ]
}

Response samples

201
400

Content type

application/json

{"meta": {"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
},
"messages": [{"role": "user",
"content": "string",
"sources": ["string"
],
"ts": "string"
}
],
"summary": ""
}

SessionClaimRoute

path Parameters

session_id

required

string

Responses

Response samples

201
400

Content type

application/json

{"meta": {"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
},
"messages": [{"role": "user",
"content": "string",
"sources": ["string"
],
"ts": "string"
}
],
"summary": ""
}

SessionSetSummaryRoute

path Parameters

session_id

required

string

Request Body schema: application/json
required

summary

required

string

Responses

Request samples

Payload

Content type

application/json

{"summary": "string"
}

Response samples

200
400

Content type

application/json

{"meta": {"id": "string",
"title": "string",
"created_at": "string",
"updated_at": "string",
"model_ref": "string",
"scope": "string",
"message_count": 0,
"origin": "tui"
},
"messages": [{"role": "user",
"content": "string",
"sources": ["string"
],
"ts": "string"
}
],
"summary": ""
}

ExportRoute

query Parameters

format	string Default: ""
source	string Default: ""

Responses

Response samples

200
400

Content type

application/json

"string"

ImportRoute

query Parameters

format

string

Default: ""

Responses

Response samples

201
400

Content type

application/json

null

PlacementRoute

Responses

Response samples

200

Content type

application/json

{"gpus": [{"index": 0,
"backend": "string",
"label": "string",
"name": "string",
"total_bytes": 0,
"free_bytes": 0
}
],
"roles": [{"role": "embed",
"model": "string",
"devices": [0
],
"tensor_split": [0
],
"replicas": 0
}
],
"unplaceable": ["string"
],
"manual": true,
"spec_json": "string",
"skipped_not_installed": [ ],
"co_tenants": [ ],
"notice": "string"
}

PlacementSetRoute

Request Body schema: application/json
required

object or null

Responses

Request samples

Payload

Content type

application/json

{"spec": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
}

Response samples

200
400

Content type

application/json

{"gpus": [{"index": 0,
"backend": "string",
"label": "string",
"name": "string",
"total_bytes": 0,
"free_bytes": 0
}
],
"roles": [{"role": "embed",
"model": "string",
"devices": [0
],
"tensor_split": [0
],
"replicas": 0
}
],
"unplaceable": ["string"
],
"manual": true,
"spec_json": "string",
"skipped_not_installed": [ ],
"co_tenants": [ ],
"notice": "string"
}

PlacementClearRoute

Responses

Response samples

200

Content type

application/json

{"gpus": [{"index": 0,
"backend": "string",
"label": "string",
"name": "string",
"total_bytes": 0,
"free_bytes": 0
}
],
"roles": [{"role": "embed",
"model": "string",
"devices": [0
],
"tensor_split": [0
],
"replicas": 0
}
],
"unplaceable": ["string"
],
"manual": true,
"spec_json": "string",
"skipped_not_installed": [ ],
"co_tenants": [ ],
"notice": "string"
}

PlacementPreviewRoute

Request Body schema: application/json
required

object or null

Responses

Request samples

Payload

Content type

application/json

{"spec": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
}

Response samples

200
400

Content type

application/json

{"gpus": [{"index": 0,
"backend": "string",
"label": "string",
"name": "string",
"total_bytes": 0,
"free_bytes": 0
}
],
"roles": [{"role": "embed",
"model": "string",
"devices": [0
],
"tensor_split": [0
],
"replicas": 0
}
],
"unplaceable": ["string"
],
"manual": true,
"spec_json": "string",
"skipped_not_installed": [ ],
"co_tenants": [ ],
"notice": "string"
}

GpusRoute

Responses

Response samples

200

Content type

application/json

{"gpus": [{"index": 0,
"backend": "string",
"label": "string",
"name": "string",
"total_bytes": 0,
"free_bytes": 0
}
],
"notice": "string"
}

GpuStatsStreamRoute

Responses

Response samples

200

Content type

application/json

null

CrawlRoute

Request Body schema: application/json
required

url required	string
	integer or null
	integer or null
	CrawlRenderMode (string) or null
include_subdomains	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"depth": 0,
"max_pages": 0,
"render_mode": "http",
"include_subdomains": false
}

Response samples

201
400

Content type

application/json

null

SetupCrawlerRoute

Responses

Response samples

201

Content type

application/json

null

SetupCrawlerStatusRoute

Responses

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

WikiListRoute

Responses

Response samples

200

Content type

application/json

[{"property1": null,
"property2": null
}
]

WikiReadRoute

path Parameters

slug

required

string

Responses

Response samples

200
400

Content type

application/json

Example

WikiPageDetail

{"slug": "string",
"title": "",
"content": ""
}

WikiDraftsRoute

Responses

Response samples

200

Content type

application/json

[{"slug": "string",
"path": "string",
"drift_ratio": 0,
"faithfulness_score": 0,
"bad_title": false,
"published_path": "string",
"published_exists": false,
"mtime": 0,
"pending_kind": "string"
}
]

WikiDraftDiffRoute

path Parameters

slug

required

string

Responses

Response samples

200
400

Content type

application/json

{"slug": "string",
"diff": "string"
}

WikiDraftAcceptRoute

path Parameters

slug

required

string

Responses

Response samples

201
400

Content type

application/json

{"slug": "string",
"requested_slug": "string",
"moved_to": "string",
"reindexed_chunks": 0
}

WikiDraftRejectRoute

path Parameters

slug

required

string

Responses

Response samples

200
400

Content type

application/json

{"slug": "string"
}

WikiCitationsReverseRoute

query Parameters

source

string

Default: ""

Responses

Response samples

200
400

Content type

application/json

[{"wiki_source": "",
"wiki_chunk_index": 0,
"citation_key": "",
"claim_type": "fact",
"source_filename": "",
"source_hash": "",
"page_start": 0,
"page_end": 0,
"line_start": 0,
"line_end": 0,
"excerpt": "",
"created_at": ""
}
]

WikiLintRoute

Responses

Response samples

201

Content type

application/json

{"issues": [ ],
"errors": 0,
"warnings": 0
}

WikiPruneRoute

Responses

Response samples

201

Content type

application/json

{"records": [ ],
"archived": 0,
"flagged": 0
}

WikiBuildRoute

Responses

Response samples

201

Content type

application/json

{"paths": [ ],
"entities": 0,
"count": 0
}

WikiUpdateRoute

Responses

Response samples

200

Content type

application/json

{"paths": [ ],
"entities": 0,
"count": 0
}

WikiStatusRoute

Responses

Response samples

200

Content type

application/json

{"wiki_enabled": true,
"summaries": 0,
"drafts": 0,
"pages": 0,
"lint_errors": 0,
"lint_warnings": 0
}

WikiSynthesizeRoute

Responses

Response samples

201

Content type

application/json

{"paths": [ ],
"count": 0
}

lilbee (0.6.90b420.dev725)

HealthRoute

Responses

Response samples

WarmStreamRoute

Responses

Response samples

StatusRoute

Responses

Response samples

ShutdownRoute

Responses

Response samples

ConfigRoute

Responses

Response samples

ConfigUpdateRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ConfigDefaultsRoute

Responses

Response samples

SourceContentRoute

query Parameters

Responses

Response samples

SearchRoute

query Parameters

Responses

Response samples

AskRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AskStreamRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ChatRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ChatStreamRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ListModelsEndpoint

Responses

Response samples

ChatCompletionsEndpoint

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SyncRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AddRoute

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AddUploadRoute

Request Body schema: multipart/form-datarequired

Responses

Response samples

ModelsListRoute

Responses

Response samples

ModelsExternalRoute

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required