Build around
the local engine.
Technical documentation for the authenticated REST API that connects OpenSS interfaces to capture, OCR, chat and local processing.
Security boundary
A real API, with a local contract.
OpenSS runs a FastAPI server on loopback. It is an internal integration surface for a running desktop engine, not a public cloud endpoint. That boundary shapes every page here: short-lived credentials, approved origins, temporary captures and explicit cleanup.
Read authentication and securityChoose the layer
you need to touch.
Connect to the engine
Use the authenticated REST contract that powers the desktop and localhost browser interface.
Read the API overviewTUTORIALAnalyze a screenshot
Follow one complete workflow from launch-token exchange to streamed answer and cleanup.
Open the quickstartCLIAutomate from Terminal
Start the local GUI, script capture and inspect engine behavior from macOS shell workflows.
View CLI guidanceFrom pixels
to a useful answer.
One compact integration journey demonstrates the parts that matter in a real client: compatibility, authentication, binary-derived context, streaming and resource ownership.
GET /api/versionConfirm the engine and API contract before touching a protected route.
POST /api/session/exchangeTurn the local launch credential into an in-memory session token.
POST /api/screenshots/captureCapture a supported app and receive OCR plus a temporary screenshot ID.
POST /api/chat/streamConsume delta events, then persist the final session ID from done.
DELETE /api/screenshots/{id}Remove the temporary capture as soon as the workflow ends.
A curated local contract.
OpenAPI, Swagger UI and ReDoc are disabled in the engine. This reference is maintained from the FastAPI routes and Pydantic schemas so it can explain the intended lifecycle without publishing authentication internals.