Skip to content

API Reference

Two complementary references are published here: the Python SDK reference, generated from the source of every library in wittgenstein-core, and the platform's OpenAPI endpoints.

Python SDK Reference

The SDK Reference tab documents each wittgenstein-* library: every public module, class and function, with the signatures and docstrings taken straight from the source. There is no hand-maintained copy to drift.

  • Authentication

    JWT verification, role checks and the same-origin token endpoint.

    oidc_backend

  • LLM routing

    Provider-agnostic routing for model calls.

    llm_router

  • Observability

    Tracing and telemetry helpers shared by every service.

    observability

  • Pipelines

    Composable data and agent pipelines.

    pipelines

How it is generated

On every build, the documentation site clones wittgenstein-core and runs mkapi over each library under libs/. Generation is cached per library: each lib is fingerprinted by the last commit that touched its directory, and only libs with new commits are regenerated. Everything else is served from the previous run.

$ make build
[sync-core-api] fetching new wittgenstein-core commits
[sync-core-api] core@8f7bfa93: 21 libs, 2 to regenerate (oidc-backend, pipelines)
[sync-core-api] wrote 21 packages to docs/reference/
INFO    -  Building documentation to directory: site
INFO    -  Documentation built in 14.20 seconds
$ make build
[sync-core-api] wittgenstein-core has no new commits, skipping fetch
[sync-core-api] core@8f7bfa93: 21 libs, 0 to regenerate — everything served from cache
[sync-core-api] wrote 21 packages to docs/reference/

To force a full regeneration, set FORCE_API_REBUILD=1. Only the libs/ tree is checked out, and the libraries are parsed, never imported, so the docs build needs none of their runtime dependencies.

Write good docstrings

The reference is only as good as the docstrings it reads. Document the why in the module docstring, list arguments and return values in Google style, and add a short example for anything non-obvious.

Platform OpenAPI

The Core API specification is exposed dynamically.