Skip to main content

Python, sync and async

The Python package mirrors the public /v1 namespaces with Pydantic models, safe retries, cursor pages, and synchronous or asynchronous clients.
The Python client requires Python 3.12 or newer and currently ships as verified wheel and source-distribution artifacts with each GitHub release, not from PyPI. Install synapse-spec and synapse-client from the same version bundle.

Install

Start a subject journey

Async applications

Contract notes

  • SynapseClient and AsyncSynapseClient expose matching namespaces and models.
  • ApiError exposes status, detail, request_id, retry_after, and response headers.
  • Use list_all_* helpers when you explicitly want to consume every cursor page.
  • Pass a persisted opaque idempotency_key for every mutation.