ZEN API#
Python wrappers for the ZEN API, enabling programmatic control of ZEISS microscopy software via gRPC.
Installation#
This package is not available on PyPI. Install from the wheel file:
pip install zen_api-2026.05.1-py3-none-any.whl
Requirements#
- Python >= 3.10
- betterproto == 2.0.0b7
API Domains#
The ZEN API is organized into several domains:
| Domain | Description |
|---|---|
| acquisition | Experiment and image acquisition services |
| application | Application-level composition services |
| common | Shared data types and enumerations |
| em | Electron microscopy hardware and workflow services |
| hardware | Microscope hardware control (stages, axes) |
| lm | Light microscopy acquisition, hardware, live scan, and slide scan services |
| workflows | Automated workflow and job management services |
Quick Start#
from zen_api.acquisition.v1beta import ExperimentServiceStub
# Connect to ZEN API server
# (requires ZEN software running with API server enabled)
License#
Apache License 2.0 — see LICENSE for details.
Copyright © Carl Zeiss Microscopy GmbH.