Seeq APIs and SDKs
Seeq provides several application programming interfaces (APIs) and software development kits (SDKs) that can be used to extend Seeq functionality with software code.
Seeq Server REST API
Seeq Server SDK
Seeq provides software development kits (SDKs) to interface with the Seeq Server in each of the following languages:
Python
Java
C#
MATLAB*

The latest version of the Seeq Server SDK is available from the Customer Download page.
These SDKs are programmatically derived from the Seeq Server REST API, and therefore all functionality available from the REST API is available from the SDKs. Each of the main sections is exposed as an API object, and all of the endpoints are methods on that object. Due to the differences between the format of a REST API and the format of a C#/Java/Python method/function, you sometimes have to use the short description of the function to correlate it with the appropriate endpoint in the REST API documentation.
The SDKs are available in the sdk folder of the Seeq Server installation, which on Windows is usually C:\Program Files\Seeq Server\sdk. Example code is included for each SDK in the examples folder, and provides a good introduction to how the SDK is used. There is also a Python SDK Quick Start using PyCharm.
*There is also a MATLAB SDK that provides programmatic access to signals and conditions from MATLAB. It is not programmatically derived from the REST API, and only provides a small subset of functionality. But it covers the most typical use case: Getting data out of Seeq and into MATLAB for advanced data processing. There are example scripts in the samples folder that show how to use the provided functions.
Seeq Server & SDK Version Compatibility
The Seeq Server SDK uses semantic version format of MAJOR.MINOR.PATCH
that corresponds to the same MAJOR.MINOR.PATCH
version on the Seeq Server’s API Reference page. Any SDK with the same MAJOR
version as the server API will be compatible, but using the exact matching version will enure the latest functionality and bugfixes are available. For example, API version R66.14.2
would use SDK version 66.14.2
for an exact match, but any SDK from 66.0.0
through 66.999.999
would compatible.
As part of our continuous delivery process, all public-facing functions will be maintained under a deprecation flag for a minimum of one year before being removed or undergoing breaking changes such as altered input/output types. Breaking changes in the SDK will be denoted by an incremented MAJOR
version.
It is recommend that customers regularly monitor their log output for deprecation warnings issued. These warnings identify which functions or endpoints are planned for removal and provide guidance on alternatives. Additionally, Seeq's release notes will highlight version-specific changes and deprecations. Automation or client libraries that integrate with Seeq outside of Data Lab should upgrade their libraries at least once per quarter to stay ahead of upcoming breaking changes.