Skip to Content
This documentation is provided with the HEAT environment and is relevant for this HEAT instance only.
Client runtimes & SDKs

Client runtimes & SDKs

Client runtimes and SDKs let you integrate external applications with HEAT: create sessions, upload data, and manage workflows from your own code without calling the raw HEAT APIs directly.

HEAT.Common (C# / .NET)

HEAT.Common is the supported .NET client for HEAT. Use it from console apps, web APIs, workers, or simulator integrations to:

  • Connect to HEAT (external URL or in-cluster) with token or username/password authentication.
  • Create sessions (with optional session template), create or join shared sessions, and close them.
  • Upload raw data (files or streams) to node instances in a session.
  • Enumerate session templates, projects, platform configuration, and node outputs.

Full documentation: HEAT.Common Client (C#) — installation, authentication, API reference, models, configuration, example project, error handling, and troubleshooting.

Example project: A runnable console app that demonstrates the full upload workflow is in the repo at runtimes/csharp/HEAT.Common.Example. See that project’s README and the Example project section in the HEAT.Common docs for how to run it.

When to use: Use HEAT.Common when you are building a .NET application that pushes data into HEAT or manages sessions. For runners (containerized processors that run inside HEAT and execute node tasks), use the HEAT runtime for your language (e.g. Python heat-runtime) instead.


Other runtimes

Additional client runtimes (e.g. Python, JavaScript/TypeScript) may be documented here as they become available. For low-level API access, see the External API V2 and Offline tokens documentation.