Reference

Generated reference documentation, regenerated from the source on every docs build (npm run gen).

Python API

The public surface of the machinable package. Each page documents one class with a per-method anchor you can link to.

• Interface — the unit of machinable
• Execution — the mechanism that runs interfaces
• Inference — scientific questions as interfaces
• Widget — results a human can look at
• Project — the directory a session binds to
• Storage — durable homes for run directories
• Index — the SQLite catalog behind lookup and search
• Scope — predicate tagging for grouped runs
• Query — the machinable.get entry point
• Collections — result collections
• Helpers — Field, references, from_cli

HTTP API

The server's contract, rendered from the live application:

• HTTP endpoints — the REST surface, by route family
• WebSocket protocol — frames, binary flows, hooks
• Schemas — every request/response model

The running server also documents itself: GET /openapi.json, the interactive /docs, and GET /v1/protocol.