ZEN API#

Python wrappers for the ZEN API, enabling programmatic control of ZEISS microscopy software via gRPC.

Package	Documented version
`zen_api`	`2026.5.1`
`zen_api_utils`	`0.1.0`

This site pairs the selected API sources with the utility sources from this repository checkout. The packages are independently versioned.

See the utilities guide, Python API references, and protocol definitions.

Installation#

This package is not available on PyPI. Install from the wheel file:

pip install zen_api-2026.5.1-py3-none-any.whl
pip install zen_api_utils-0.1.0-py3-none-any.whl

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

from zen_api.acquisition.v1beta import ExperimentServiceStub

# Connect to ZEN API server
# (requires ZEN software running with API server enabled)

Apache License 2.0 — see LICENSE for details.