User Guide

Using the API

Introduction

The Sympheny API is a REST API that developers can use to connect with Sympheny Web Application to create integration, retrieve data, and automate your workflows.

This quick start documentation helps developers with example of workflows, incluidng detailed sections for each aspect of using our different APIs, including code samples for commonly used languages.

The complete list of APIs available for your subscription plan is available on:

  • Web App APIs, for the core functionalities provided by Sympheny Web application.

  • Web App APIs V3, V3 for specific to V3 APIs listing.

  • Energy Services APIs, for the additional advanced energy planning services provided by Sympheny Web application.

The curl command are provided and can be converted to any others languages using a curl converter, for example in:

Picture1API2.png


Sympheny EnyFlow Framework – Documentation for API Users

This document explains how Sympheny users can work with the Sympheny API using the EnyFlow platform, both:

  1. In Google Colab (“using Colab”)

  2. Within the Sympheny EnyFlow Jupyter framework

Picture1API.png
Sympheny examples within Colab
Picture1API3.png
Sympheny EnyFlow access