orbiter_server
Web UI and API server for running Orbiter agents via HTTP, WebSocket, and SSE.
Web UI and API server for running Orbiter agents via HTTP, WebSocket, and SSE.
python
from orbiter_server import (
# app — FastAPI application
ChatRequest,
ChatResponse,
create_app,
register_agent,
# agents — agent management routes
AgentInfo,
WorkspaceFile,
WorkspaceFileContent,
# sessions — session management
AppendMessageRequest,
CreateSessionRequest,
Session,
SessionMessage,
SessionSummary,
UpdateSessionRequest,
)Install: pip install "orbiter-server @ git+https://github.com/Midsphere-AI/orbiter-ai.git#subdirectory=packages/orbiter-server"
Submodules
| Module | Description |
|---|---|
orbiter_server.app | FastAPI app factory, /chat endpoint, agent registry |
orbiter_server.agents | Agent management and workspace routes |
orbiter_server.sessions | Session CRUD and message history |
orbiter_server.streaming | WebSocket and SSE streaming endpoints |
Public API summary
| Export | Kind | Source |
|---|---|---|
ChatRequest | Pydantic model | app |
ChatResponse | Pydantic model | app |
create_app | Function | app |
register_agent | Function | app |
AgentInfo | Pydantic model | agents |
WorkspaceFile | Pydantic model | agents |
WorkspaceFileContent | Pydantic model | agents |
AppendMessageRequest | Pydantic model | sessions |
CreateSessionRequest | Pydantic model | sessions |
Session | Pydantic model | sessions |
SessionMessage | Pydantic model | sessions |
SessionSummary | Pydantic model | sessions |
UpdateSessionRequest | Pydantic model | sessions |
Quick start
python
from orbiter_server import create_app, register_agent
from orbiter.agent import Agent
# Create agent
agent = Agent(name="helper", model="openai:gpt-4o", instructions="You are helpful.")
# Create and configure app
app = create_app()
register_agent(app, agent, default=True)
# Run with: uvicorn app:app --host 0.0.0.0 --port 8000