Skip to content
Navigation

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

ModuleDescription
orbiter_server.appFastAPI app factory, /chat endpoint, agent registry
orbiter_server.agentsAgent management and workspace routes
orbiter_server.sessionsSession CRUD and message history
orbiter_server.streamingWebSocket and SSE streaming endpoints

Public API summary

ExportKindSource
ChatRequestPydantic modelapp
ChatResponsePydantic modelapp
create_appFunctionapp
register_agentFunctionapp
AgentInfoPydantic modelagents
WorkspaceFilePydantic modelagents
WorkspaceFileContentPydantic modelagents
AppendMessageRequestPydantic modelsessions
CreateSessionRequestPydantic modelsessions
SessionPydantic modelsessions
SessionMessagePydantic modelsessions
SessionSummaryPydantic modelsessions
UpdateSessionRequestPydantic modelsessions

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