API Overview

xplainpy ships several client classes layered on top of the same Xplain web API. Pick one based on what you need:

Client

When to use

xplain.XplainSession (recommended)

All new code. Single entry point with 8 namespaces (xp.query, xp.select, xp.temporal, xp.dimensions, xp.models, xp.data, xp.explore, xp.config). Created via xplain.create_session() or XplainSession.from_profile().

xplain.Xsession (legacy)

Existing code. Still fully supported. See Legacy.

xplain.session_client.XplainClient (low-level)

Calling an endpoint that isn’t yet exposed on XplainSession. Auto-generated from the OpenAPI spec. See Legacy.

Reading order

If you are new to xplainpy:

  1. Getting Started — install + authenticate

  2. Tutorials — work through the examples (all use XplainSession)

  3. Entry Points — the two equivalent ways to create a session

  4. XplainSession — full method reference for the 8 namespaces

If you maintain existing Xsession-based code, jump to Legacy.