The olix developer API

Build on the olix core and its local models from your own tools. The API is a small gateway on your Mac: loopback only, off until the owner turns it on, one token per app, and every action that changes something still waits for the owner's approval in olix.

Status. olix is in development and is not yet available to download. This API is built and tested in the repository; the examples on these pages were run against an isolated test-mode core with a stand-in engine, so the model text in them is a placeholder, not model output.

What you get

Turns. Run one olix turn and stream its events (POST /v1/turns), or wait for the result. Sessions, transcripts and file changes of your app's own sessions.
Local models. An OpenAI-compatible /v1/chat/completions over the models installed on the Mac, by their display names. Point the official OpenAI SDK at localhost.
History (owner opt-in per app). Read the owner's saved sessions with the history.read scope.
A socket. The same API as newline-delimited JSON on a mode-0600 unix socket.
SDKs. Node and Python, standard library only.

What it will not do

Leave the machine. No remote bind, no tunnel, no telemetry.
Approve an action. An API client can only deny; the owner approves in the olix app.
Touch the vault or memory, steal focus, or type credentials.

The full list, with the tests that enforce each line, is on the Safety model page.

Start here

Quickstart: enable, create a token, send a turn. About five minutes.
Auth, scopes and limits
Endpoint reference and events, both generated from the JSON Schema the gateway enforces.

Scopes

scope	grants
`models`	Local model completions only (GET /v1/models, POST /v1/chat/completions). No tools, no sessions.
`chat`	Turns and sessions of this app's own sessions. A turn runs the olix loop; actions that change something wait for the owner.
`history.read`	Read the owner's saved sessions (all apps). The owner grants it per token, with --scopes.
`computer` Coming	Coming. Missions on the owner's Mac. Not built; a token cannot be created with it yet.

Coming

Custom tools (tools.register): a developer's local tool the olix loop can call, treated by the action gate as at least consequential unless proven read-only. Not built; it needs a core change.
The computer scope: missions on the owner's Mac.
A Mycel SDK, after the Mycel language ships.