Files
OpenJarvis/docs/api/server.md
T
Jon Saad-FalconandClaude Opus 4.6 a433740809 Add 30 tests for security/channels coverage gaps and 6 new docs pages
Tests: GuardrailsEngine.stream() async tests, OpenClawChannelBridge listener_loop
tests, channel CLI command tests, FileReadTool sensitive file blocking, ingest_path
sensitive file filtering, SecurityConfig/ChannelConfig config tests. Documentation:
new user guides, architecture pages, and API references for Security and Channels
modules; updated CLAUDE.md, configuration docs, CLI reference, and mkdocs.yml nav.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-22 03:31:19 +00:00

2.5 KiB

Server Module

The server module provides an OpenAI-compatible API server built on FastAPI and uvicorn. It exposes POST /v1/chat/completions (with streaming via SSE), GET /v1/models, and GET /health endpoints. Pydantic models ensure request/response validation matching the OpenAI API format.

Application Factory

create_app

::: openjarvis.server.app.create_app options: show_source: true


Route Handlers

chat_completions

::: openjarvis.server.routes.chat_completions options: show_source: true

list_models

::: openjarvis.server.routes.list_models options: show_source: true

health

::: openjarvis.server.routes.health options: show_source: true


Pydantic Request/Response Models

ChatMessage

::: openjarvis.server.models.ChatMessage options: show_source: true members_order: source

ChatCompletionRequest

::: openjarvis.server.models.ChatCompletionRequest options: show_source: true members_order: source

ChatCompletionResponse

::: openjarvis.server.models.ChatCompletionResponse options: show_source: true members_order: source

Choice

::: openjarvis.server.models.Choice options: show_source: true members_order: source

ChoiceMessage

::: openjarvis.server.models.ChoiceMessage options: show_source: true members_order: source

UsageInfo

::: openjarvis.server.models.UsageInfo options: show_source: true members_order: source

ChatCompletionChunk

::: openjarvis.server.models.ChatCompletionChunk options: show_source: true members_order: source

DeltaMessage

::: openjarvis.server.models.DeltaMessage options: show_source: true members_order: source

StreamChoice

::: openjarvis.server.models.StreamChoice options: show_source: true members_order: source

ModelObject

::: openjarvis.server.models.ModelObject options: show_source: true members_order: source

ModelListResponse

::: openjarvis.server.models.ModelListResponse options: show_source: true members_order: source


Channel Endpoints

list_channels

::: openjarvis.server.routes.list_channels options: show_source: true

channel_send

::: openjarvis.server.routes.channel_send options: show_source: true

channel_status

::: openjarvis.server.routes.channel_status options: show_source: true