Repository navigation
Expand file tree
/
Copy pathapi.py
More file actions
785 lines (726 loc) · 28.8 KB
/
Copy pathapi.py
File metadata and controls
785 lines (726 loc) · 28.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
"""FastAPI REST service for OpenKB query and chat."""
from __future__ import annotations
import argparse
import asyncio
import logging
import os
from contextlib import asynccontextmanager
from typing import Any
import litellm
from agents import set_tracing_disabled
from dotenv import load_dotenv
from fastapi import (
Depends,
FastAPI,
File,
Form,
HTTPException,
Query,
Request,
UploadFile,
status,
)
from fastapi.responses import FileResponse, StreamingResponse
from starlette.concurrency import run_in_threadpool
from openkb.agent.chat import build_chat_session_agent, iter_chat_turn_events
from openkb.agent.chat_session import delete_session, list_sessions, load_session
from openkb.agent.query import build_run_config_from_bundle, run_query
from openkb.api_config import apply_kb_config_patch, read_kb_config
from openkb.api_config_router import config_router
from openkb.api_documents_router import documents_router
from openkb.api_graph import graph_router
from openkb.api_helpers import (
_configure_cors,
_init_kb_for_api,
_iter_deck,
_iter_skill,
_load_or_create_session,
_mount_web_ui,
_parse_stream_form,
_reserve_add_uploads,
_resolve_kb,
_run_add_uploads,
_save_query_answer,
_stream_add_uploads,
_stream_chat,
_stream_deck,
_stream_query,
_stream_recompile,
_stream_remove,
_stream_skill,
_stream_watch_events,
_write_add_uploads,
require_bearer_token,
)
from openkb.api_kbs import _list_knowledge_bases
from openkb.api_kbs_router import kbs_router
from openkb.api_models import (
AddResponse,
ChatRequest,
ChatResponse,
ChatSessionDeleteRequest,
ChatSessionDeleteResponse,
ChatSessionListResponse,
ChatSessionLoadRequest,
ChatSessionLoadResponse,
DeckListResponse,
DeckRequest,
DeckResponse,
EnvWritten,
InitRequest,
InitResponse,
KbConfigPatchRequest,
KbConfigResponse,
KbListResponse,
KbRequest,
LintRequest,
LintResponse,
ListResponse,
MetaResponse,
QueryRequest,
QueryResponse,
RecompileRequest,
RecompileResponse,
RemoveRequest,
RemoveResponse,
SkillListResponse,
SkillRequest,
SkillResponse,
StatusResponse,
WatchStartRequest,
WatchStatusResponse,
)
from openkb.api_output import output_router
from openkb.api_pages_router import pages_router
from openkb.cli import (
get_kb_list,
get_kb_status,
iter_recompile,
run_lint_report,
run_remove_for_api,
)
from openkb.config import (
DEFAULT_CONFIG,
resolve_credential_bundle,
resolve_effective_config,
resolve_init_kb_dir,
validate_kb_name,
)
from openkb.log import append_log
from openkb.watch_service import WatchRegistry
logger = logging.getLogger(__name__)
def create_app() -> FastAPI:
# One registry per app instance so each TestClient is isolated.
# Keep process-wide setup inside create_app() so importing the module
# does not mutate global state for tests or library consumers.
set_tracing_disabled(True)
os.environ.setdefault("LITELLM_LOCAL_MODEL_COST_MAP", "true")
litellm.suppress_debug_info = True
load_dotenv()
registry = WatchRegistry()
# Per-KB asyncio locks for async mutation endpoints (lint/recompile).
# kb_ingest_lock tracks reentrancy in threading.local, but the event loop
# runs all requests on one thread, so concurrent same-KB mutations are
# mis-counted as re-entrant and bypass mutual exclusion. An asyncio.Lock
# serializes same-KB mutations *before* they enter the threading lock,
# eliminating the hazard without touching locks.py.
kb_mutation_locks: dict[str, asyncio.Lock] = {}
def _kb_mutation_lock(kb: str) -> asyncio.Lock:
lock = kb_mutation_locks.get(kb)
if lock is None:
lock = asyncio.Lock()
kb_mutation_locks[kb] = lock
return lock
@asynccontextmanager
async def lifespan(app: FastAPI):
# Auth is opt-in (see require_bearer_token). Warn once at server startup
# when no token is configured, so an exposed deployment is never
# silently world-open. Fires for every launch path (uvicorn/gunicorn/
# the openkb-api CLI); harmless on loopback. (create_app() can't see the
# bind host under a factory launch, so this is host-agnostic.)
if not os.environ.get("OPENKB_API_TOKEN"):
logger.warning(
"OPENKB_API_TOKEN is not set — the REST API is unauthenticated. "
"This is fine for local use; set OPENKB_API_TOKEN to require a "
"bearer token before exposing the server on a reachable interface."
)
try:
yield
finally:
registry.stop_all()
app = FastAPI(title="OpenKB API", lifespan=lifespan)
_configure_cors(app)
app.include_router(graph_router)
app.include_router(output_router)
app.include_router(config_router)
app.include_router(kbs_router)
app.include_router(pages_router)
app.include_router(documents_router)
@app.get("/api/v1/kbs", response_model=KbListResponse)
async def list_kbs_endpoint(
_: None = Depends(require_bearer_token),
) -> KbListResponse:
return KbListResponse(**_list_knowledge_bases())
@app.get("/api/v1/meta", response_model=MetaResponse)
async def meta_endpoint(
_: None = Depends(require_bearer_token),
) -> MetaResponse:
from openkb import __version__
return MetaResponse(version=__version__)
@app.get("/api/v1/kb/config", response_model=KbConfigResponse)
async def kb_config_get_endpoint(
kb: str = Query(...),
_: None = Depends(require_bearer_token),
) -> KbConfigResponse:
return read_kb_config(_resolve_kb(kb))
@app.patch("/api/v1/kb/config", response_model=KbConfigResponse)
async def kb_config_patch_endpoint(
request: KbConfigPatchRequest,
_: None = Depends(require_bearer_token),
) -> KbConfigResponse:
# The merge-PATCH is a read-modify-write over config.yaml + .env; hold
# the per-KB mutation lock so two concurrent patches cannot drop fields.
kb_dir = _resolve_kb(request.kb)
async with _kb_mutation_lock(request.kb):
apply_kb_config_patch(kb_dir, request)
return read_kb_config(kb_dir)
@app.post("/api/v1/init", response_model=InitResponse)
async def init_endpoint(
request: InitRequest,
_: None = Depends(require_bearer_token),
) -> InitResponse:
try:
kb_name = validate_kb_name(request.kb)
kb_dir = resolve_init_kb_dir(kb_name, request.path)
# Run lock-holding work in a threadpool so each request gets its
# own threading.local (kb_ingest_lock reentrancy is per-thread)
# and the event loop is not blocked by file I/O / flock.
result = await run_in_threadpool(
_init_kb_for_api,
kb_dir,
kb_name,
model=request.model,
api_key=request.api_key,
openai_api_base=request.openai_api_base,
)
except (ValueError, FileExistsError) as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=str(exc),
) from exc
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Init failed: {exc}",
) from exc
return InitResponse(
kb=kb_name,
created=bool(result["created"]),
env_written=EnvWritten(**result["env_written"]),
message=str(result["message"]),
)
@app.post("/api/v1/add", response_model=AddResponse)
async def add_endpoint(
kb: str = Form(...),
stream: str = Form("true"),
files: list[UploadFile] = File(default=[]),
_: None = Depends(require_bearer_token),
) -> Any:
resolved_kb_dir = _resolve_kb(kb)
bundle = resolve_credential_bundle(resolved_kb_dir)
if not files:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="No files uploaded.",
)
# Reserve unique raw paths under the lock so concurrent same-name
# uploads cannot race on _unique_raw_path and overwrite each other,
# then stream the bodies outside it so a large or slow upload does not
# block other same-KB mutations (lint/recompile/other adds).
async with _kb_mutation_lock(kb):
reserved = _reserve_add_uploads(resolved_kb_dir, files)
saved_uploads = await _write_add_uploads(reserved, files)
if _parse_stream_form(stream):
return StreamingResponse(
_stream_add_uploads(kb, resolved_kb_dir, saved_uploads, bundle=bundle),
media_type="text/event-stream",
)
return await _run_add_uploads(kb, resolved_kb_dir, saved_uploads, bundle=bundle)
@app.post("/api/v1/query", response_model=QueryResponse)
async def query_endpoint(
request: QueryRequest,
fastapi_request: Request,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
config = resolve_effective_config(kb_dir)[0]
model = config.get("model", DEFAULT_CONFIG["model"])
run_config = build_run_config_from_bundle(model, bundle)
if request.stream:
return StreamingResponse(
_stream_query(request, kb_dir, model, fastapi_request, bundle=bundle),
media_type="text/event-stream",
)
try:
answer = await run_query(
request.question,
kb_dir,
model,
stream=False,
run_config=run_config,
bundle=bundle,
)
append_log(kb_dir / "wiki", "query", request.question)
saved_path = (
_save_query_answer(kb_dir, request.question, answer) if request.save else None
)
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Query failed: {exc}",
) from exc
return QueryResponse(
answer=answer,
saved_path=str(saved_path) if saved_path else None,
)
@app.post("/api/v1/chat", response_model=ChatResponse)
async def chat_endpoint(
request: ChatRequest,
fastapi_request: Request,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
session = _load_or_create_session(kb_dir, request.session_id)
run_config = build_run_config_from_bundle(session.model, bundle)
if request.stream:
return StreamingResponse(
_stream_chat(request, kb_dir, session, fastapi_request, bundle=bundle),
media_type="text/event-stream",
)
try:
answer = ""
append_log(kb_dir / "wiki", "query", request.message)
agent = build_chat_session_agent(kb_dir, session, bundle=bundle)
async for event in iter_chat_turn_events(
agent, session, request.message, run_config=run_config
):
if event["event"] == "final":
answer = event["data"]["answer"]
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Chat failed: {exc}",
) from exc
return ChatResponse(
session_id=session.id,
answer=answer,
turn_count=session.turn_count,
)
@app.post("/api/v1/chat/sessions", response_model=ChatSessionListResponse)
async def chat_sessions_endpoint(
request: KbRequest,
_: None = Depends(require_bearer_token),
) -> ChatSessionListResponse:
kb_dir = _resolve_kb(request.kb)
try:
sessions = list_sessions(kb_dir)
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"List sessions failed: {exc}",
) from exc
return ChatSessionListResponse(kb=request.kb, sessions=sessions)
@app.post("/api/v1/chat/sessions/load", response_model=ChatSessionLoadResponse)
async def chat_session_load_endpoint(
request: ChatSessionLoadRequest,
_: None = Depends(require_bearer_token),
) -> ChatSessionLoadResponse:
kb_dir = _resolve_kb(request.kb)
try:
session = load_session(kb_dir, request.session_id)
except FileNotFoundError as exc:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Chat session not found: {request.session_id}",
) from exc
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Load session failed: {exc}",
) from exc
return ChatSessionLoadResponse(
session_id=session.id,
title=session.title,
turn_count=session.turn_count,
user_turns=session.user_turns,
assistant_texts=session.assistant_texts,
assistant_traces=session.assistant_traces,
)
@app.post("/api/v1/chat/sessions/delete", response_model=ChatSessionDeleteResponse)
async def chat_session_delete_endpoint(
request: ChatSessionDeleteRequest,
_: None = Depends(require_bearer_token),
) -> ChatSessionDeleteResponse:
kb_dir = _resolve_kb(request.kb)
try:
deleted = delete_session(kb_dir, request.session_id)
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Delete session failed: {exc}",
) from exc
if not deleted:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Chat session not found: {request.session_id}",
)
return ChatSessionDeleteResponse(deleted=True)
@app.post("/api/v1/list", response_model=ListResponse)
async def list_endpoint(
request: KbRequest,
_: None = Depends(require_bearer_token),
) -> ListResponse:
kb_dir = _resolve_kb(request.kb)
try:
return ListResponse(**get_kb_list(kb_dir))
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"List failed: {exc}",
) from exc
@app.post("/api/v1/status", response_model=StatusResponse)
async def status_endpoint(
request: KbRequest,
_: None = Depends(require_bearer_token),
) -> StatusResponse:
kb_dir = _resolve_kb(request.kb)
try:
return StatusResponse(**get_kb_status(kb_dir))
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Status failed: {exc}",
) from exc
@app.post("/api/v1/lint", response_model=LintResponse)
async def lint_endpoint(
request: LintRequest,
_: None = Depends(require_bearer_token),
) -> LintResponse:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
try:
# Only fix=True mutations need serialization; read-only lint
# (fix=False) is a report and may run concurrently.
if request.fix:
async with _kb_mutation_lock(request.kb):
return LintResponse(**await run_lint_report(kb_dir, fix=True, bundle=bundle))
return LintResponse(**await run_lint_report(kb_dir, fix=False, bundle=bundle))
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Lint failed: {exc}",
) from exc
@app.post("/api/v1/remove", response_model=RemoveResponse)
async def remove_endpoint(
request: RemoveRequest,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
if request.stream:
return StreamingResponse(
_stream_remove(request, kb_dir),
media_type="text/event-stream",
)
result = await run_in_threadpool(
run_remove_for_api,
kb_dir,
request.identifier,
keep_raw=request.keep_raw,
keep_empty=request.keep_empty,
dry_run=request.dry_run,
)
status_value = result.get("status")
if status_value == "not_found":
raise HTTPException(
status_code=404, detail=result.get("message", "Document not found.")
)
if status_value == "multiple":
raise HTTPException(
status_code=409,
detail={
"message": "Identifier matches multiple documents.",
"candidates": result.get("candidates", []),
},
)
return RemoveResponse(**result)
@app.post("/api/v1/recompile", response_model=RecompileResponse)
async def recompile_endpoint(
request: RecompileRequest,
fastapi_request: Request,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
if request.stream:
lock = _kb_mutation_lock(request.kb)
return StreamingResponse(
_stream_recompile(request, kb_dir, lock, fastapi_request, bundle=bundle),
media_type="text/event-stream",
)
# Aggregate the async generator into a single JSON response. Terminal
# errors map to HTTP codes; the final event carries the aggregate.
targets: list[dict] | None = None
candidates: list[dict[str, str]] | None = None
error_code: int | None = None
error_message: str | None = None
result: dict = {}
async with _kb_mutation_lock(request.kb):
async for event in iter_recompile(
kb_dir,
request.doc_name,
all_docs=request.all_docs,
dry_run=request.dry_run,
refresh_schema=request.refresh_schema,
bundle=bundle,
):
name = event.get("event")
if name == "plan":
targets = event.get("targets", [])
elif name == "error":
error_code = event.get("code", 500)
error_message = event.get("message", "Recompile failed.")
candidates = event.get("candidates")
elif name == "final":
result = event
if error_code is not None:
if error_code == 409 and candidates is not None:
raise HTTPException(
status_code=409,
detail={"message": error_message, "candidates": candidates},
)
raise HTTPException(status_code=error_code, detail=error_message)
return RecompileResponse(
status=result.get("status", "done"),
total=result.get("total", 0),
recompiled=result.get("recompiled", 0),
skipped=result.get("skipped", 0),
docs=result.get("docs", []),
targets=targets,
candidates=candidates,
)
@app.post("/api/v1/watch/start", response_model=WatchStatusResponse)
async def watch_start_endpoint(
request: WatchStartRequest,
_: None = Depends(require_bearer_token),
) -> WatchStatusResponse:
kb_dir = _resolve_kb(request.kb)
try:
registry.start(request.kb, kb_dir, debounce=request.debounce)
except Exception as exc:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Watch start failed: {exc}",
) from exc
return WatchStatusResponse(**registry.status(request.kb))
@app.post("/api/v1/watch/stop", response_model=WatchStatusResponse)
async def watch_stop_endpoint(
request: KbRequest,
_: None = Depends(require_bearer_token),
) -> WatchStatusResponse:
_resolve_kb(request.kb)
if not registry.stop(request.kb):
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"No active watcher for KB: {request.kb}",
)
# Return the real post-stop status. If the worker was mid-compile and
# entered draining mode, status() reports active=True; otherwise it
# reports active=False after the watcher has been removed.
return WatchStatusResponse(**registry.status(request.kb))
@app.post("/api/v1/watch/status", response_model=WatchStatusResponse)
async def watch_status_endpoint(
request: KbRequest,
_: None = Depends(require_bearer_token),
) -> WatchStatusResponse:
_resolve_kb(request.kb)
return WatchStatusResponse(**registry.status(request.kb))
@app.get("/api/v1/watch/events")
async def watch_events_endpoint(
request: Request,
kb: str = Query(..., min_length=1),
max_events: int | None = Query(default=None, ge=1),
timeout_seconds: float | None = Query(default=None, ge=0),
_: None = Depends(require_bearer_token),
) -> Any:
_resolve_kb(kb)
return StreamingResponse(
_stream_watch_events(registry, kb, max_events, timeout_seconds, request),
media_type="text/event-stream",
)
@app.post("/api/v1/deck", response_model=DeckResponse)
async def deck_endpoint(
request: DeckRequest,
fastapi_request: Request,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
if request.stream:
lock = _kb_mutation_lock(request.kb)
return StreamingResponse(
_stream_deck(request, kb_dir, lock, fastapi_request, bundle=bundle),
media_type="text/event-stream",
)
error_code: int | None = None
error_message: str | None = None
result: dict = {}
async with _kb_mutation_lock(request.kb):
async for event in _iter_deck(request, kb_dir, bundle=bundle):
name = event.get("event")
if name == "error":
error_code = event.get("code", 500)
error_message = event.get("message", "Deck generation failed.")
elif name == "final":
result = event
if error_code is not None:
raise HTTPException(status_code=error_code, detail=error_message)
return DeckResponse(name=result["name"], status=result["status"], path=result["path"])
@app.get("/api/v1/deck", response_model=DeckListResponse)
async def deck_list_endpoint(
kb: str = Query(...),
_: None = Depends(require_bearer_token),
) -> DeckListResponse:
from openkb.deck import decks_root
kb_dir = _resolve_kb(kb)
root = decks_root(kb_dir)
decks = (
sorted(
p.name for p in root.iterdir() if p.is_dir() and not p.name.endswith("-workspace")
)
if root.is_dir()
else []
)
return DeckListResponse(decks=[{"name": n} for n in decks])
@app.get("/api/v1/deck/{name}")
async def deck_download_endpoint(
name: str,
kb: str = Query(...),
_: None = Depends(require_bearer_token),
) -> Any:
from openkb.cli import _validate_skill_name
from openkb.deck import deck_dir, decks_root
if _validate_skill_name(name):
raise HTTPException(status_code=400, detail="Invalid deck name.")
kb_dir = _resolve_kb(kb)
root = decks_root(kb_dir).resolve()
target = deck_dir(kb_dir, name).resolve()
if not target.is_relative_to(root):
raise HTTPException(status_code=400, detail="Invalid deck name.")
index = target / "index.html"
if not index.is_file():
raise HTTPException(status_code=404, detail=f"Deck not found: {name}")
return FileResponse(index, media_type="text/html")
@app.post("/api/v1/skill", response_model=SkillResponse)
async def skill_endpoint(
request: SkillRequest,
fastapi_request: Request,
_: None = Depends(require_bearer_token),
) -> Any:
kb_dir = _resolve_kb(request.kb)
bundle = resolve_credential_bundle(kb_dir)
if request.stream:
lock = _kb_mutation_lock(request.kb)
return StreamingResponse(
_stream_skill(request, kb_dir, lock, fastapi_request, bundle=bundle),
media_type="text/event-stream",
)
error_code: int | None = None
error_message: str | None = None
result: dict = {}
async with _kb_mutation_lock(request.kb):
async for event in _iter_skill(request, kb_dir, bundle=bundle):
name = event.get("event")
if name == "error":
error_code = event.get("code", 500)
error_message = event.get("message", "Skill generation failed.")
elif name == "final":
result = event
if error_code is not None:
raise HTTPException(status_code=error_code, detail=error_message)
return SkillResponse(name=result["name"], status=result["status"], path=result["path"])
@app.get("/api/v1/skill", response_model=SkillListResponse)
async def skill_list_endpoint(
kb: str = Query(...),
_: None = Depends(require_bearer_token),
) -> SkillListResponse:
from openkb.skill import skills_root
kb_dir = _resolve_kb(kb)
root = skills_root(kb_dir)
skills = (
sorted(
p.name for p in root.iterdir() if p.is_dir() and not p.name.endswith("-workspace")
)
if root.is_dir()
else []
)
return SkillListResponse(skills=[{"name": n} for n in skills])
@app.get("/api/v1/skill/{name}/archive")
async def skill_archive_endpoint(
name: str,
kb: str = Query(...),
_: None = Depends(require_bearer_token),
) -> Any:
import io
import zipfile
from openkb.cli import _validate_skill_name
from openkb.skill import skill_dir, skills_root
if _validate_skill_name(name):
raise HTTPException(status_code=400, detail="Invalid skill name.")
kb_dir = _resolve_kb(kb)
root = skills_root(kb_dir).resolve()
target = skill_dir(kb_dir, name).resolve()
if not target.is_relative_to(root):
raise HTTPException(status_code=400, detail="Invalid skill name.")
if not target.is_dir():
raise HTTPException(status_code=404, detail=f"Skill not found: {name}")
buf = io.BytesIO()
with zipfile.ZipFile(buf, "w", zipfile.ZIP_DEFLATED) as zf:
for f in target.rglob("*"):
if f.is_file():
zf.write(f, f.relative_to(target))
buf.seek(0)
return StreamingResponse(buf, media_type="application/zip")
# Catch-all for unknown API paths so they return JSON 404 instead of being
# swallowed by the StaticFiles mount below (which serves index.html for SPA
# routing and would turn API 404s into HTML 200s).
@app.api_route(
"/api/{path:path}",
methods=["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"],
)
async def api_not_found(path: str) -> Any:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="Not found",
)
_mount_web_ui(app)
return app
def main() -> None:
parser = argparse.ArgumentParser(description="Run the OpenKB REST API.")
parser.add_argument("--host", default="127.0.0.1")
parser.add_argument("--port", type=int, default=7566)
parser.add_argument("--reload", action="store_true")
args = parser.parse_args()
import uvicorn
# Use the factory so uvicorn can reload a fresh app instance and so the
# module can be imported without triggering global side effects.
uvicorn.run(
"openkb.api:create_app",
host=args.host,
port=args.port,
reload=args.reload,
factory=True,
)
if __name__ == "__main__":
main()