API docs by Redocly

lilbee (0.6.90b420)

Download OpenAPI specification:

Local knowledge base REST API

HealthRoute

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string",
  • "chat_ready": false,
  • "chat_status": "ready",
  • "chat_error": "string",
  • "chat_ctx": 0
}

WarmStreamRoute

Responses

StatusRoute

Responses

Response samples

Content type
application/json
{
  • "command": "status",
  • "config": {
    },
  • "sources": [
    ],
  • "total_chunks": 0,
  • "entities": {
    }
}

ShutdownRoute

Responses

Response samples

Content type
application/json
{
  • "status": "shutting_down"
}

ConfigRoute

Responses

Response samples

Content type
application/json
{ }

ConfigUpdateRoute

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Response samples

Content type
application/json
{
  • "updated": [
    ],
  • "reindex_required": true
}

ConfigDefaultsRoute

Responses

Response samples

Content type
application/json
{ }

SourceContentRoute

query Parameters
source
required
string
raw
boolean
Default: false

Responses

Response samples

Content type
application/json
Example
{
  • "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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "question": "string",
  • "top_k": 0,
  • "options": {
    },
  • "chunk_type": "raw"
}

Response samples

Content type
application/json
{
  • "answer": "string",
  • "sources": [
    ],
  • "cited_sources": [
    ],
  • "compaction": {
    }
}

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

Content type
application/json
{
  • "question": "string",
  • "top_k": 0,
  • "options": {
    },
  • "chunk_type": "raw"
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

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

Content type
application/json
{
  • "question": "string",
  • "history": [ ],
  • "top_k": 0,
  • "options": {
    },
  • "chunk_type": "raw",
  • "summary": "",
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "answer": "string",
  • "sources": [
    ],
  • "cited_sources": [
    ],
  • "compaction": {
    }
}

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

Content type
application/json
{
  • "question": "string",
  • "history": [ ],
  • "top_k": 0,
  • "options": {
    },
  • "chunk_type": "raw",
  • "summary": "",
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

ListModelsEndpoint

Responses

Response samples

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

Content type
application/json
{
  • "model": "string",
  • "messages": [
    ],
  • "tools": [
    ],
  • "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": {
    }
}

Response samples

Content type
application/json
null

MessagesEndpoint

Request Body schema: application/json
required
model
required
string
max_tokens
required
integer
required
Array of objects (AnthropicMessage)
string or Array of SystemTextBlock (objects) or null
Array of AnthropicTool (objects) or null
AnthropicToolChoice (object) or null
number or null
number or null
integer or null
Array of strings or null
stream
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "max_tokens": 0,
  • "messages": [
    ],
  • "system": "string",
  • "tools": [
    ],
  • "tool_choice": {
    },
  • "temperature": 0,
  • "top_p": 0,
  • "top_k": 0,
  • "stop_sequences": [
    ],
  • "stream": false
}

Response samples

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

Content type
application/json
Example
{
  • "enable_ocr": true,
  • "force_rebuild": false,
  • "retry_skipped": false
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

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

Content type
application/json
{
  • "paths": [
    ],
  • "force": false,
  • "enable_ocr": true,
  • "ocr_timeout": 0
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

AddUploadRoute

Request Body schema: multipart/form-data
required
files
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

ModelsListRoute

Responses

Response samples

Content type
application/json
{
  • "chat": {
    },
  • "embedding": {
    },
  • "vision": {
    },
  • "reranker": {
    }
}

ModelsExternalRoute

Responses

Response samples

Content type
application/json
{
  • "models": [
    ],
  • "error": "string"
}

ModelsSetChatRoute

Request Body schema: application/json
required
model
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string"
}

Response samples

Content type
application/json
{
  • "model": "string",
  • "reindex_required": false
}

ModelsSetEmbeddingRoute

Request Body schema: application/json
required
model
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string"
}

Response samples

Content type
application/json
{
  • "model": "string",
  • "reindex_required": false
}

ModelsSetVisionRoute

Request Body schema: application/json
required
model
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string"
}

Response samples

Content type
application/json
{
  • "model": "string",
  • "reindex_required": false
}

ModelsSetRerankerRoute

Request Body schema: application/json
required
model
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string"
}

Response samples

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

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "models": [
    ],
  • "has_more": false
}

ModelsInstalledRoute

Responses

Response samples

Content type
application/json
{
  • "models": [
    ]
}

ModelsPullRoute

Request Body schema: application/json
required
model
required
string
source
string
Default: "native"
allow_unsupported
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "source": "native",
  • "allow_unsupported": false
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

ModelsShowRoute

Request Body schema: application/json
required
model
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string"
}

Response samples

Content type
application/json
{ }

ModelsDeleteRoute

path Parameters
model
required
string
query Parameters
source
string
Default: "native"

Responses

Response samples

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

Content type
application/json
{
  • "documents": [
    ],
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "has_more": false
}

DocumentsRemoveRoute

Request Body schema: application/json
required
names
required
Array of strings <= 100 items

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "removed": [
    ],
  • "not_found": [
    ]
}

MemoriesListRoute

Responses

Response samples

Content type
application/json
{
  • "memories": [
    ]
}

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

Content type
application/json
{
  • "text": "string",
  • "kind": "preference",
  • "shared": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "preference"
}

MemoriesRemoveRoute

path Parameters
memory_id
required
string

Responses

Response samples

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

Content type
application/json
{
  • "shared": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "updated": true
}

SessionsListRoute

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ]
}

SessionCreateRoute

Request Body schema: application/json
required
model_ref
required
string
scope
required
string

Responses

Request samples

Content type
application/json
{
  • "model_ref": "string",
  • "scope": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "messages": [
    ],
  • "summary": ""
}

SessionGetRoute

path Parameters
session_id
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "messages": [
    ],
  • "summary": ""
}

SessionDeleteRoute

path Parameters
session_id
required
string

Responses

Response samples

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

Content type
application/json
{
  • "title": "string"
}

Response samples

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

Content type
application/json
{
  • "role": "user",
  • "content": "string",
  • "sources": [ ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "messages": [
    ],
  • "summary": ""
}

SessionClaimRoute

path Parameters
session_id
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "messages": [
    ],
  • "summary": ""
}

SessionSetSummaryRoute

path Parameters
session_id
required
string
Request Body schema: application/json
required
summary
required
string

Responses

Request samples

Content type
application/json
{
  • "summary": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "messages": [
    ],
  • "summary": ""
}

ExportRoute

query Parameters
format
string
Default: ""
source
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

ImportRoute

query Parameters
format
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

PlacementRoute

Responses

Response samples

Content type
application/json
{
  • "gpus": [
    ],
  • "roles": [
    ],
  • "unplaceable": [
    ],
  • "manual": true,
  • "spec_json": "string",
  • "skipped_not_installed": [ ],
  • "co_tenants": [ ],
  • "notice": "string",
  • "rejected_spec_json": "string"
}

PlacementSetRoute

Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "gpus": [
    ],
  • "roles": [
    ],
  • "unplaceable": [
    ],
  • "manual": true,
  • "spec_json": "string",
  • "skipped_not_installed": [ ],
  • "co_tenants": [ ],
  • "notice": "string",
  • "rejected_spec_json": "string"
}

PlacementClearRoute

Responses

Response samples

Content type
application/json
{
  • "gpus": [
    ],
  • "roles": [
    ],
  • "unplaceable": [
    ],
  • "manual": true,
  • "spec_json": "string",
  • "skipped_not_installed": [ ],
  • "co_tenants": [ ],
  • "notice": "string",
  • "rejected_spec_json": "string"
}

PlacementPreviewRoute

Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "gpus": [
    ],
  • "roles": [
    ],
  • "unplaceable": [
    ],
  • "manual": true,
  • "spec_json": "string",
  • "skipped_not_installed": [ ],
  • "co_tenants": [ ],
  • "notice": "string",
  • "rejected_spec_json": "string"
}

GpusRoute

Responses

Response samples

Content type
application/json
{
  • "gpus": [
    ],
  • "notice": "string"
}

GpuStatsStreamRoute

Responses

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

Content type
application/json
{
  • "url": "string",
  • "depth": 0,
  • "max_pages": 0,
  • "render_mode": "http",
  • "include_subdomains": false
}

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

AgentConfigIndexRoute

Responses

Response samples

Content type
application/json
{
  • "clients": [
    ]
}

AgentConfigRoute

path Parameters
client
required
string

Responses

Response samples

Content type
application/json
{
  • "client": "claude",
  • "format": "json",
  • "surfaces": [
    ],
  • "config": {
    },
  • "content": "string",
  • "stdio_config": {
    }
}

SetupCrawlerRoute

Responses

SetupCrawlerStatusRoute

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

WikiListRoute

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WikiWipeRoute

Responses

Response samples

Content type
application/json
{
  • "pages_removed": 0,
  • "sources_cleared": 0,
  • "rows_deleted": true
}

WikiReadRoute

path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "slug": "string",
  • "title": "",
  • "content": "",
  • "frontmatter": { }
}

WikiDraftsRoute

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WikiDraftDiffRoute

path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "slug": "string",
  • "diff": "string"
}

WikiDraftAcceptRoute

path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "slug": "string",
  • "requested_slug": "string",
  • "moved_to": "string",
  • "reindexed_chunks": 0
}

WikiDraftRejectRoute

path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "slug": "string"
}

WikiCitationsReverseRoute

query Parameters
source
string
Default: ""

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WikiLintRoute

query Parameters
wiki_source
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "issues": [ ],
  • "total": 0,
  • "errors": 0,
  • "warnings": 0
}

WikiPruneRoute

Responses

Response samples

Content type
application/json
{
  • "records": [ ],
  • "archived": 0,
  • "flagged": 0,
  • "reconciled": 0
}

WikiIndexRoute

Responses

Response samples

Content type
application/json
{
  • "entries": 0
}

WikiStubsRoute

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WikiGenerateRoute

path Parameters
slug
required
string

Responses

Response samples

Content type
application/json
{
  • "status_code": 400,
  • "detail": "Bad Request",
  • "extra": { }
}

WikiBuildRoute

query Parameters
dry_run
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "entities": [ ],
  • "count": 0,
  • "note": ""
}

WikiUpdateRoute

Responses

WikiStatusRoute

Responses

Response samples

Content type
application/json
{
  • "wiki_enabled": true,
  • "summaries": 0,
  • "drafts": 0,
  • "pages": 0,
  • "lint_errors": 0,
  • "lint_warnings": 0
}

WikiSynthesizeRoute

Responses