API docs by Redocly

lilbee (0.6.66b456)

Download OpenAPI specification:

Local knowledge base REST API

HealthRoute

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "version": "string"
}

StatusRoute

Responses

Response samples

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

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 <= 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 <= 100
Default: 0
object or null
string or null

Responses

Request samples

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

Response samples

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

AskStreamRoute

Request Body schema: application/json
required
question
required
string
top_k
integer <= 100
Default: 0
object or null
string or null

Responses

Request samples

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

Response samples

Content type
application/json
null

ChatRoute

Request Body schema: application/json
required
question
required
string
history
any
Default: []
top_k
integer <= 100
Default: 0
object or null
string or null

Responses

Request samples

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

Response samples

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

ChatStreamRoute

Request Body schema: application/json
required
question
required
string
history
any
Default: []
top_k
integer <= 100
Default: 0
object or null
string or null

Responses

Request samples

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

Response samples

Content type
application/json
null

SyncRoute

Request Body schema: application/json
required
One of
boolean or null
force_rebuild
boolean
Default: false

Responses

Request samples

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

Response samples

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

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

Response samples

Content type
application/json
null

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
sort
string
Default: "featured"
limit
integer <= 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"

Responses

Request samples

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

Response samples

Content type
application/json
null

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 <= 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
delete_files
boolean
Default: false

Responses

Request samples

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

Response samples

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

CrawlRoute

Request Body schema: application/json
required
url
required
string
integer or null
integer or null >= 1

Responses

Request samples

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

Response samples

Content type
application/json
null

SetupCrawlerRoute

Responses

Response samples

Content type
application/json
null

SetupCrawlerStatusRoute

Responses

Response samples

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

WikiListRoute

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WikiReadRoute

path Parameters
slug
required
string

Responses

Response samples

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

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

Responses

Response samples

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

WikiPruneRoute

Responses

Response samples

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

WikiBuildRoute

Responses

Response samples

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

WikiUpdateRoute

Responses

Response samples

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

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

Response samples

Content type
application/json
{
  • "paths": [ ],
  • "count": 0
}