logo
API docs by Redocly

REFORMERS Digital Twin: Model API Server (v0.1)

Download OpenAPI specification:Download

License: MIT

This API provides the model creation and validation capabilities of the digital twin. A family of models, which can be data or equation-based, is created in an automated way by the digital twin. The models differ in resolution and computational complexity, spanning different energy vectors (heat, electricity, gas) and having different time and component details. The models are calibrated to real-world data. These models are used by different digital twin services

Funding acknowledgement: The REFORMERS project has received funding from the European Union’s research and innovation programme Horizon Europe under the Grant Agreement No.101136211

Find out more about REFORMERS

Model Generators

Retrieve information about model generators

Get list of model generator names

Authorizations:
BearerAuthentication

Responses

Response samples

Content type
application/json
{
  • "model-generator-name1": [
    ],
  • "model-generator-name2": [
    ]
}

Get information about model generator

Authorizations:
BearerAuthentication
path Parameters
generator-name
required
string (model generator name) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: example-generator

unique name for a model generator

generator-tag
required
string (model generator tag) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: v0

tag for a specific version of a model generator

Responses

Response samples

Content type
application/json
{
  • "generator_name": "example-generator",
  • "generator_tag": "v0",
  • "parameters": {
    },
  • "config": {
    },
  • "build": {
    }
}

Models

Create models and retrieve model information

Get information about available models

Authorizations:
BearerAuthentication
path Parameters
generator-name
required
string (model generator name) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: example-generator

unique name for a model generator

generator-tag
required
string (model generator tag) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: v0

tag for a specific version of a model generator

Responses

Response samples

Content type
application/json
{
  • "generator_name": "example-generator",
  • "generator_tag": "v0",
  • "models": {
    }
}

Create new model

Authorizations:
BearerAuthentication
path Parameters
generator-name
required
string (model generator name) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: example-generator

unique name for a model generator

generator-tag
required
string (model generator tag) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: v0

tag for a specific version of a model generator

Request Body schema: application/json
model_name
required
string (model name) ^[a-z0-9][a-z0-9-]+$

unique name for a model

model_tag
required
string (model generator tag) ^[a-z0-9][a-z0-9-]+$

tag for a specific version of a model

object (model generator parameters used for creating this model)

Responses

Request samples

Content type
application/json
{
  • "model_name": "mvlv-urban-all-0-sw",
  • "model_tag": "v1",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "task-id": "Z3JpZC1zaW06djA6MTc0MzUzNTQ1Ni41Nzc5MzE=",
  • "status": "finished",
  • "creation-date": "2025-07-21T17:32:28Z",
  • "info": "string"
}

Status

Retrieve information about model generation tasks

Retrieve information about model generation tasks

Authorizations:
BearerAuthentication
path Parameters
generator-name
required
string (model generator name) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: example-generator

unique name for a model generator

generator-tag
required
string (model generator tag) ^[a-zA-Z0-9][a-zA-Z0-9-]+$
Example: v0

tag for a specific version of a model generator

query Parameters
task-id
required
string (ID of model generation task) ^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$
Example: task-id=Z3JpZC1zaW06djA6MTc0MzUzNTQ1Ni41Nzc5MzE=

Responses

Response samples

Content type
application/json
{
  • "task-id": "Z3JpZC1zaW06djA6MTc0MzUzNTQ1Ni41Nzc5MzE=",
  • "status": "finished",
  • "creation-date": "2025-07-21T17:32:28Z",
  • "info": "string"
}

Info

Retrieve additional information about model API

Get authentication info

Authorizations:
BearerAuthentication

Responses

Response samples

Content type
application/json
{
  • "date": "2024-10-04T09:20:21.736525+00:00"
}