How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Aedifion

aedifion HTTP API

Versioned REST API (v2) for the aedifion.io building operations platform. Covers company, realm, project and user administration; datapoint and timeseries read/write; virtual datapoints; the semantic component/pin data model; analytics runs and results; cloud-based controls apps, setpoints and schedules; alerts and tasks; a document database; and an AI assistant. 208 operations across 147 paths, every one carrying an operationId, summary, description and tag. Authentication is HTTP Basic (legacy) or OpenID Connect bearer tokens issued by the aedifion Keycloak realm.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 208 operations across 147 paths, organized into 12 resource areas, and defines 239 schemas. It is described by OpenAPI 3.0.1.

Requests are made against the base URL https://api.aedifion.io.

208 operations 147 paths 239 schemas 43 DELETE79 GET3 PATCH59 POST24 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
Base URL
https://api.aedifion.io
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
12

Authentication & Security 2

aedifion HTTP API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (openIDConnect) using the implicit flow, exposing 1 scope.

Paths & Operations 208

Across 147 paths, the API surfaces 208 operations — 43 DELETE, 79 GET, 3 PATCH, 59 POST, 24 PUT. They span 12 resource areas, including Meta, Alert, Analytics, Company, Realm, Component, Controls, Datapoint, and 4 more. Each is listed below with its method, path, parameters, and response codes.

Meta 6

Meta management resources.

GET
/ping
Ping api server.
ping → 200401
GET
/v2/labels/definitions
Get labels definitions.
get_labels_definitions 1 param → 200
GET
/v2/labels/systems
Get available labels systems.
get_labels_systems → 200
GET
/v2/meta/api_version
Get api version.
get_api_version → 200401
GET
/v2/meta/endpoints
Get a list of available endpoints.
get_endpoints → 200401
GET
/v2/meta/ready
Check API readiness by verifying external dependencies.
get_api_readiness → 200503
Alert 8

Creating, modifying, and accessing alerts and related resources.

POST
/v2/alert/discrete
Create a new discrete value alert.
post_alert_discrete 1 param body → 201401415
POST
/v2/alert/threshold
Create a new threshold alert.
post_alert_threshold 1 param body → 201401415
POST
/v2/alert/throughput
Create a new throughput alert.
post_alert_throughput 1 param body → 201401415
DELETE
/v2/alert/{alert_id}
Delete an alert.
delete_alert_new 1 param → 204401404
GET
/v2/alert/{alert_id}
Get an alert.
get_alert 1 param → 200401404
PATCH
/v2/alert/{alert_id}
Partially update an alert.
patch_alert 1 param body → 200400401404
POST
/v2/alert/{alert_id}/disable
Disable an alert.
disable_alert 1 param → 200401404
POST
/v2/alert/{alert_id}/enable
Enable an alert.
enable_alert 1 param → 200401404
Analytics 25

Creating, modifying, and accessing analytics and related resources.

GET
/v2/analytics/componentInProject/{componentinproject_id}/results
Get analysis result references for a component.
get_component_results 5 params → 200
GET
/v2/analytics/components/kpi_aggregation
Get aggregated KPI results for components.
get_components_kpi_aggregation 13 params → 200
GET
/v2/analytics/componentsInProject
Get components in a project with signal color.
get_analysis_components 6 params → 200
GET
/v2/analytics/functions
Get a list of available analysis functions.
get_analysis_functions 3 params → 200
POST
/v2/analytics/instance
Create an analysis instance.
post_analysis_instance 1 param body → 200
DELETE
/v2/analytics/instance/{instance_id}
Delete an analysis instance configured in a project.
delete_analysis_instance 2 params → 200401
GET
/v2/analytics/instance/{instance_id}
Get a detailed analysis instance.
get_analysis_instance 2 params → 200404
PUT
/v2/analytics/instance/{instance_id}
Update an analysis instance.
put_analysis_instance 2 params body → 200
GET
/v2/analytics/instance/{instance_id}/result/{result_id}
Get the result of an executed instance.
get_instance_result 6 params → 200
GET
/v2/analytics/instance/{instance_id}/results
Get list of executions for an analysis instance.
get_instance_results 5 params → 200
POST
/v2/analytics/instance/{instance_id}/run
Run an analysis instance.
post_analysis_instance_run 4 params → 200401
GET
/v2/analytics/instances
Get details of all analysis instances.
get_analysis_instances 1 param → 200
POST
/v2/analytics/instances/run
Run analysis instances in batch.
post_analytics_instances_run 4 params → 201207401
POST
/v2/analytics/instances/scheduled/run
Run all scheduled analysis instances of a project.
post_analytics_scheduled_instances_run 4 params → 201207401
POST
/v2/analytics/kpi
Post a KPI for a component.
post_analytics_kpi 1 param body → 201401
DELETE
/v2/analytics/kpi/{kpi_id}
Delete a KPI of a project.
delete_user_analytics_kpi 1 param → 400404
GET
/v2/analytics/kpi_aggregation
Get aggregated KPI results for projects.
get_kpi_aggregation 9 params → 200
GET
/v2/analytics/overview
Get an overview of analysis results for all component types.
get_analytics_overview 2 params → 200
GET
/v2/analytics/potentials
Get savings potentials for a project.
get_potentials 4 params → 200
GET
/v2/analytics/projects/kpis_aggregation
Get aggregated KPI results across projects.
get_projects_kpis_aggregation 6 params → 200
DELETE
/v2/analytics/result/{result_id}
Delete the result of an executed instance.
delete_instance_result 2 params → 200404
GET
/v2/analytics/savings
Get KPI savings for a project.
get_savings 4 params → 200
POST
/v2/analytics/savings
Post a saving for a project component.
post_saving 2 params body → 200404
DELETE
/v2/analytics/savings/{saving_id}
Delete a saving.
delete_saving 1 param → 204404
PATCH
/v2/analytics/savings/{saving_id}
Patch a saving.
patch_saving 2 params body → 200404
Company 29

Creating, modifying, and accessing companies and related resources.

GET
/v2/company
Get all projects and users defined in the company.
get_company → 200401
PUT
/v2/company
Update the details for the company of the logged in user.
put_company body → 200401
DELETE
/v2/company/avatar
Deletes the current avatar image of the user's company
delete_company_avatar → 200500
POST
/v2/company/avatar
Uploads and stores an image for the current user's company
post_company_avatar body → 200400500
DELETE
/v2/company/file
Delete a file on the company's document database.
delete_company_file 1 param → 200401
GET
/v2/company/file
Download a file from the company's document database.
get_company_file 2 params → 200401
POST
/v2/company/file
Upload a file to the company's document database.
post_company_file 1 param body → 200400401
PUT
/v2/company/file
Replace a file on the company's document database.
put_company_file 1 param body → 200400401
GET
/v2/company/files
Get a list of files from the company's document database.
get_company_files 3 params → 200401
GET
/v2/company/quota
Get quota for various services enabled for the company.
get_company_quota 1 param → 200401
POST
/v2/company/role
Create a new role for the logged user's company.
post_company_role body → 200401
DELETE
/v2/company/role/{role_id}
Delete an existing role for the company.
delete_company_role 1 param → 200401
PUT
/v2/company/role/{role_id}
Updates an existing role for the company.
put_company_role 1 param body → 200401
DELETE
/v2/company/role/{role_id}/user/{user_id}
Removes a role from a user.
delete_user_company_role 2 params → 200401
POST
/v2/company/role/{role_id}/user/{user_id}
Assign a role to a user.
post_user_company_role 2 params → 200401
GET
/v2/company/roles
Get all roles defined in the company.
get_company_roles → 200401
POST
/v2/company/user
Create a new user.
post_user body → 200401
DELETE
/v2/company/user/{user_id}
Delete an existing user within the company.
delete_user_company 1 param → 200401
GET
/v2/company/user/{user_id}
Get a user within the company.
get_company_user 1 param → 200401
PUT
/v2/company/user/{user_id}
Updates an existing user within the company.
put_company_user 1 param body → 200401
GET
/v2/company/{company_id}
Get all projects and users defined in the company.
get_company_by_id 1 param → 200401
POST
/v2/company/{company_id}/project-groups
Create a project group.
post_company_project_group 1 param body → 201400401404
DELETE
/v2/company/{company_id}/project-groups/{project_group_id}
Delete a project group.
delete_company_project_group 2 params → 204401404
PUT
/v2/company/{company_id}/project-groups/{project_group_id}
Rename a project group.
put_company_project_group 2 params body → 200400401404
DELETE
/v2/company/{company_id}/project-groups/{project_group_id}/projects/{project_id}
Unassign a project from a project group.
delete_project_in_project_group 3 params → 204401404
POST
/v2/company/{company_id}/project-groups/{project_group_id}/projects/{project_id}
Assign a project to a project group.
post_project_in_project_group 3 params → 204401404
DELETE
/v2/company/{company_id}/role/{role_id}/user/{user_id}
Removes a role from a user.
delete_user_company_role_by_company_id 3 params → 200401
POST
/v2/company/{company_id}/role/{role_id}/user/{user_id}
Assign a role to a user.
post_user_company_role_by_company_id 3 params → 200401
POST
/v2/company/{company_id}/user
Create a new user.
post_user_by_company_id 1 param body → 200401
Realm 7

Accessing realm-level resources.

POST
/v2/company/{company_id}/project
Create a new project.
post_company_project 1 param body → 201400401403404
POST
/v2/company/{company_id}/project/{project_id}/setup
Provision the backend resources for a project.
post_project_setup 3 params → 200400401404409503
GET
/v2/realm/companies
Get all companies.
get_companies → 200401
POST
/v2/realm/project_journey_sync
Post a project journey synchronization request.
post_project_journey_sync 1 param → 202401
DELETE
/v2/realm/role/user/{user_id}
Delete the realm role from a user.
delete_user_realm_role 1 param → 200401
POST
/v2/realm/role/{role_id}/user/{user_id}
Assign a new realm role to the user.
post_user_realm_role 2 params → 200401
GET
/v2/realm/roles
Get all available realm roles.
get_realm_roles → 200401
Component 3

Creating, modifying, and accessing components and related resources.

GET
/v2/component/{component_id}/attributeDefinitions
Get all available attribute definitions for the component.
get_component_attribute_definitions 2 params → 200401
GET
/v2/component/{component_id}/pins
Get all pins and its attributes for the component.
get_component_pins 2 params → 200401
GET
/v2/components
Get all available components.
get_components 1 param → 200401
Controls 11

Creating, modifying, and accessing controls apps and related resources.

GET
/v2/controls/algorithms_by_component
Get a list of controls algorithms and their variations with details grouped by components.
get_controls_algorithms_by_component 2 params → 200401
DELETE
/v2/controls/app
Delete a controls app in the project.
delete_controls_app 2 params → 200401
POST
/v2/controls/app
Create a controls app in the project.
post_controls_app 6 params body → 202401
POST
/v2/controls/app/custom
Create a custom controls app in the project.
post_controls_app_custom 6 params body → 202401
GET
/v2/controls/app/{controls_app_id}
Get a controls app in the project.
get_controls_app 3 params → 200401
GET
/v2/controls/app/{controls_app_id}/logs
Get logs of a controls app in the project.
get_controls_app_logs 9 params → 200401
POST
/v2/controls/app/{controls_app_id}/run
Request to run or stop a controls app in the project.
post_controls_app_run 3 params → 200401
GET
/v2/controls/apps
Get a list of controls apps in the project.
get_controls_apps 6 params → 200401
POST
/v2/controls/apps/run
Request to run or stop multiple controls apps in the project.
post_controls_apps_run 3 params → 200401
GET
/v2/controls/apps/summary
Get a summary of controls apps grouped by algorithm for a project.
get_controls_apps_summary 2 params → 200401
POST
/v2/controls/apps/update
Request to update multiple controls apps in the project.
post_controls_apps_update 3 params → 200401
Datapoint 12

Creating, modifying, and accessing datapoints and related resources.

DELETE
/v2/datapoint
Delete a datapoint.
delete_datapoint 2 params → 202401403
GET
/v2/datapoint
Get details about data point.
get_datapoint 2 params → 200401
PUT
/v2/datapoint
Change datapoint details.
put_datapoint 2 params body → 200401
DELETE
/v2/datapoint/favorite
Remove a personal favorite data point.
delete_datapoint_favorite 2 params → 200401
POST
/v2/datapoint/favorite
Set a data point as personal favorite.
post_datapoint_favorite 2 params → 200401
POST
/v2/datapoint/setpoint
Write a setpoint.
post_datapoint_setpoint 7 params → 200401
GET
/v2/datapoint/setpoint/{reference}
Retrieve acknowledgement for setpoint write operation.
get_datapoint_setpoint 1 param → 200401404
POST
/v2/datapoint/tag
Add a tag.
post_datapoint_tag 4 params → 200401
DELETE
/v2/datapoint/tag/{tag_id}
Remove tag from data point.
delete_datapoint_tag 3 params → 200401
PUT
/v2/datapoint/tag/{tag_id}
Update tag associated with data point.
put_datapoint_tag 3 params body → 200401
DELETE
/v2/datapoint/timeseries
Delete timeseries data for a datapoint.
delete_datapoint_timeseries 5 params → 200400
GET
/v2/datapoint/timeseries
Get the time series data of a data point.
get_datapoint_timeseries 13 params → 200401422
Project 83

Creating, modifying, and accessing projects and related resources.

DELETE
/v2/project/{project_id}
Delete project.
delete_project 2 params → 200400401404
GET
/v2/project/{project_id}
Get project's details.
get_project 1 param → 200401
PUT
/v2/project/{project_id}
Update project's details.
put_project 1 param body → 200401
POST
/v2/project/{project_id}/ai/consent
Grant or revoke the consent for AI Assistant.
post_ai_assistant_consent 2 params → 200401
GET
/v2/project/{project_id}/alerts
Get all alerts in a project.
get_alerts 7 params → 200401
DELETE
/v2/project/{project_id}/avatar
Deletes the current avatar image of the project
delete_project_avatar 1 param → 200500
POST
/v2/project/{project_id}/avatar
Uploads and stores an image for the project
post_project_avatar 1 param body → 200400500
GET
/v2/project/{project_id}/comments
Get all comments of a project.
get_project_comments 3 params → 200401
POST
/v2/project/{project_id}/comments
Create a new project comment.
post_project_comment 1 param body → 201401
DELETE
/v2/project/{project_id}/comments/{comment_id}
Delete a project comment.
delete_project_comment 2 params → 204401
GET
/v2/project/{project_id}/comments/{comment_id}
Get a project comment.
get_project_comment 2 params → 200401
PUT
/v2/project/{project_id}/comments/{comment_id}
Edit a project comment.
put_project_comment 2 params body → 200401
POST
/v2/project/{project_id}/componentInProject
Add a new component in project.
post_project_component 2 params body → 200401
DELETE
/v2/project/{project_id}/componentInProject/attribute
Delete an attribute for a component in a project.
delete_project_component_attribute 3 params → 200401
POST
/v2/project/{project_id}/componentInProject/attribute
Add a new attribute to component in project.
post_project_component_attribute 2 params body → 200401
PUT
/v2/project/{project_id}/componentInProject/attribute
Edit an attribute for a component in a project.
put_project_component_attribute 5 params → 200401
PATCH
/v2/project/{project_id}/componentInProject/attributes
Change attributes of a component in project.
patch_project_component_attributes 3 params body → 200400401
DELETE
/v2/project/{project_id}/componentInProject/pin/datapoint
Delete a datapoint on component pin for the project.
delete_project_component_pin_datapoint 4 params → 200401
POST
/v2/project/{project_id}/componentInProject/pin/datapoint
Connects a datapoint to a component's pin.
post_project_component_pin_datapoint 5 params → 200401
PUT
/v2/project/{project_id}/componentInProject/pin/datapoint
Edits a datapoint on a component pin in the specified project.
put_project_component_pin_datapoint 5 params → 200401
GET
/v2/project/{project_id}/componentInProject/pin/recommendations
Get recommendations for datapoints of an instantiated component within a project.
get_project_component_recommendations 7 params → 200401
POST
/v2/project/{project_id}/componentInProject/relationship
Create a relationship between componentinprojects
post_componentinproject_relationship 1 param body → 200401
DELETE
/v2/project/{project_id}/componentInProject/relationship/{relationship_id}
Delete an existing componentinproject relationship.
delete_componentinproject_relationship 2 params → 200401
DELETE
/v2/project/{project_id}/componentInProject/{componentinproject_id}
Delete a component in the specified project.
delete_project_component 2 params → 200401
GET
/v2/project/{project_id}/componentInProject/{componentinproject_id}
Get a component for the specified project.
get_project_component 3 params → 200401
PUT
/v2/project/{project_id}/componentInProject/{componentinproject_id}
Edit a component in the specified project.
put_project_component 2 params body → 200401
GET
/v2/project/{project_id}/componentinproject/{componentinproject_id}/holidays
Get holidays of a component for the given time range.
get_project_component_holidays 6 params → 200401
GET
/v2/project/{project_id}/componentinproject/{componentinproject_id}/schedules
Get component schedules for the given time range.
get_project_component_schedules 6 params → 200401
GET
/v2/project/{project_id}/componentsInProject
Get all components in a project.
get_project_components 8 params → 200401
POST
/v2/project/{project_id}/custom_page
Create a custom page for a project.
post_custom_page 1 param body → 201400401404
DELETE
/v2/project/{project_id}/custom_page/{custom_page_id}
Delete a custom page.
delete_custom_page 2 params → 204401404
PUT
/v2/project/{project_id}/custom_page/{custom_page_id}
Update a custom page.
put_custom_page 2 params body → 200400401404
DELETE
/v2/project/{project_id}/datapoints
Delete datapoints in the project.
delete_project_datapoints 1 param body → 202401403
GET
/v2/project/{project_id}/datapoints/byPage
Get list of filtered data points in this project.
get_project_datapoints_by_page 11 params → 200401
GET
/v2/project/{project_id}/datapoints/byTag
Get all data points in this project with a given tag.
get_project_datapoints_bytag 6 params → 200401
GET
/v2/project/{project_id}/datapoints/favorites
Get a list of favorited data points in this project.
get_project_datapoints_favorites 1 param → 200401
GET
/v2/project/{project_id}/device/{device_id}
Get a device for the project.
get_project_device 2 params → 200401
GET
/v2/project/{project_id}/devices
Get a list of devices for the project.
get_project_devices 3 params → 200401
DELETE
/v2/project/{project_id}/file
Delete a file on the project's document database.
delete_project_file 2 params → 200401
GET
/v2/project/{project_id}/file
Download a file from the project's document database.
get_project_file 3 params → 200401
POST
/v2/project/{project_id}/file
Upload a file in the project's document database.
post_project_file 3 params body → 200400401
PUT
/v2/project/{project_id}/file
Replace a file on the project's document database.
put_project_file 2 params body → 200400401
GET
/v2/project/{project_id}/files
Get a list of files from the project's document database.
get_project_files 4 params → 200401
DELETE
/v2/project/{project_id}/folder
Delete a folder on the project's document database.
delete_project_folder 2 params → 200400401
POST
/v2/project/{project_id}/folder
Create a folder on the project's document database.
post_project_folder 2 params → 201400401
DELETE
/v2/project/{project_id}/hidden_native_page
Unhide a native page for a project.
delete_project_hidden_native_page 2 params → 200204400401404500
POST
/v2/project/{project_id}/hidden_native_page
Hide a native page for a project.
post_project_hidden_native_page 1 param body → 200201400401404500
POST
/v2/project/{project_id}/import-digital-twins
Start a digital twin import.
post_project_import_digital_twins 1 param body → 202400401404409422500503
POST
/v2/project/{project_id}/importTimeseries
Imports timeseries data from a file
post_project_import_timeseries 4 params body → 200401
GET
/v2/project/{project_id}/jobs
Get all jobs in a project.
get_project_jobs 5 params → 200401
GET
/v2/project/{project_id}/jobs/{job_id}/logs
Get logs of a job in the project.
get_project_job_logs 6 params → 200401
DELETE
/v2/project/{project_id}/link/{link_id}
Delete a project link.
delete_project_link 2 params → 204401404
POST
/v2/project/{project_id}/mqttuser
Create an MQTT user account.
post_project_mqttuser 1 param body → 200401
PUT
/v2/project/{project_id}/mqttuser/{mqttuser_id}
Updates an MQTT user account.
put_project_mqttuser 2 params body → 200401
POST
/v2/project/{project_id}/object-report
Trigger object report generation.
post_project_object_report 2 params → 202401404409429500
GET
/v2/project/{project_id}/object-report/status
Get status of the object report generations for a project.
get_project_object_report_status 1 param → 200401403404
POST
/v2/project/{project_id}/plot-view
Create a plot view.
post_plot_view 1 param body → 201401
DELETE
/v2/project/{project_id}/plot-view/{plot_view_id}
Delete a plot view.
delete_plot_view 2 params → 200401
GET
/v2/project/{project_id}/plot-view/{plot_view_id}
Get a plot view.
get_plot_view 2 params → 200401
PUT
/v2/project/{project_id}/plot-view/{plot_view_id}
Update a plot view.
put_plot_view 2 params body → 200401
GET
/v2/project/{project_id}/project_journey
Get project journey.
get_project_journey 1 param → 200401
GET
/v2/project/{project_id}/quota
Get quota for various services enabled for the project.
get_project_quota 2 params → 200401
POST
/v2/project/{project_id}/role
Create a new role for this project.
post_project_role 1 param body → 200401
DELETE
/v2/project/{project_id}/role/{role_id}
Delete an existing role for this project.
delete_project_role 2 params → 200401
PUT
/v2/project/{project_id}/role/{role_id}
Updates an existing role for this project.
put_project_role 2 params body → 200401
DELETE
/v2/project/{project_id}/role/{role_id}/user/{user_id}
Removes a role from a user.
delete_user_role 3 params → 200401
POST
/v2/project/{project_id}/role/{role_id}/user/{user_id}
Assign a role to a user.
post_user_role 3 params → 200401
GET
/v2/project/{project_id}/roles
Get all roles defined in the project.
get_project_roles 1 param → 200401
GET
/v2/project/{project_id}/setpoints
Get a list of setpoints defined for the project.
get_project_setpoints 4 params → 200401
POST
/v2/project/{project_id}/tag
Create a new tag.
post_project_tag 1 param body → 200401
DELETE
/v2/project/{project_id}/tag/{tag_id}
Delete a tag.
delete_project_tag 2 params → 200401
PUT
/v2/project/{project_id}/tag/{tag_id}
Update an existing tag.
put_project_tag 2 params body → 200401
GET
/v2/project/{project_id}/tags
Get all data point tags in this project.
get_project_tags 3 params → 200401
GET
/v2/project/{project_id}/tasks
Get all tasks in a project.
get_project_tasks 6 params → 200401
GET
/v2/project/{project_id}/timeseries
Get the time series data of a list of data points.
get_project_timeseries 13 params → 200401422
POST
/v2/project/{project_id}/timeseries
Add timeseries data for datapoints.
post_project_timeseries 1 param body → 201403
GET
/v2/project/{project_id}/users
Get all users of the project.
get_project_users 4 params → 200401
DELETE
/v2/project/{project_id}/virtual_datapoint
Delete a virtual datapoint in the project.
delete_project_virtual_datapoint 3 params → 200401
GET
/v2/project/{project_id}/virtual_datapoint
Get a virtual datapoint in the project.
get_project_virtual_datapoint 2 params → 200401
POST
/v2/project/{project_id}/virtual_datapoint
Create a virtual datapoint in the project.
post_project_virtual_datapoint 4 params body → 200401
PUT
/v2/project/{project_id}/virtual_datapoint
Edit a virtual datapoint in the project.
put_project_virtual_datapoint 2 params body → 200401
POST
/v2/project/{project_id}/virtual_datapoint/run
Request to run or stop a virtual datapoint in the project.
post_project_virtual_datapoint_run 3 params → 200401
GET
/v2/project/{project_id}/virtual_datapoints
Get a list of virtual datapoints in the project.
get_project_virtual_datapoints 5 params → 200401
Task 9

Creating, modifying, and accessing tasks and related resources.

POST
/v2/task
Create a new task.
post_task 1 param body → 201401
DELETE
/v2/task/comments/{comment_id}
Delete a task comment.
delete_task_comment 1 param → 204401
GET
/v2/task/comments/{comment_id}
Get a task comment.
get_task_comment 1 param → 200401
PUT
/v2/task/comments/{comment_id}
Edit a task comment.
put_task_comment 1 param body → 200401
DELETE
/v2/task/{task_id}
Delete a task.
delete_task 1 param → 204401
GET
/v2/task/{task_id}
Get a task.
get_task 2 params → 200401
PUT
/v2/task/{task_id}
Edit a task.
put_task 1 param body → 200401
GET
/v2/task/{task_id}/comments
Get all comments of a task.
get_task_comments 3 params → 200401
POST
/v2/task/{task_id}/comments
Create a new task comment.
post_task_comment 1 param body → 201401
User 11

Creating, modifying, and accessing users and related resources.

DELETE
/v2/user
CAUTION: Deletes logged in user.
delete_user → 200401
GET
/v2/user
Get logged in user's details.
get_user → 200401
PUT
/v2/user
Update the details of the logged in user.
put_user body → 200401
DELETE
/v2/user/avatar
Deletes the current profile image of the user
delete_user_avatar → 200500
POST
/v2/user/avatar
Uploads and stores an image for the current user
post_user_avatar body → 200400500
GET
/v2/user/favorites
Get user's favorite data points.
get_user_favorites → 200401
PUT
/v2/user/password
Change user's password.
put_user_password body → 200422423500
GET
/v2/user/projects
Get user's projects.
get_user_projects → 200401
DELETE
/v2/user/projects/hidden_native_page
Unhide a native page for all user projects.
delete_user_projects_hidden_native_page 1 param → 200400401403500
POST
/v2/user/projects/hidden_native_page
Hide a native page for all user projects.
post_user_projects_hidden_native_page body → 200400401403500
GET
/v2/user/projects/portfolio
Get the user's project portfolio.
get_user_projects_portfolio 2 params → 200401422
AI 4

Creating, modifying, and accessing AI related resources.

POST
/v2/user/ai/chat/{thread_id}
Chat with the AI scoped to the user.
post_chat 1 param body → 200400401
DELETE
/v2/user/ai/thread/{thread_id}
Delete a user AI conversation thread.
delete_user_conversation_thread 1 param → 204400401
GET
/v2/user/ai/thread/{thread_id}
Get all chat messages for a thread.
get_chat_history 1 param → 200403404
GET
/v2/user/ai/threads
Gets all conversation threads scoped to the user.
get_user_conversation_threads 2 params → 200400401

Schemas 239

The contract defines 239 schemas that model the data the API accepts and returns. The most detailed are Alert (30 properties), Project (21 properties), AnalysisResult (17 properties), Task (16 properties). Each schema is shown below with its type and property counts.

AIConversationThread
object
3 properties
AIConversationThreads
object
2 properties
Activity
object
4 properties 4 required
Alert
object
30 properties 7 required
AlertNotification
object
Notification channels for an alert. Each channel is optional.
4 properties
AlertThresholds
object
Trigger and reset thresholds per severity. At least one of 'info', 'warn', or 'crit' must be provided; omitted levels are not evaluated. The 'order' (ascending…
7 properties
AnalysisFunction
object
9 properties 5 required
AnalysisFunctionShort
object
3 properties 3 required
AnalysisResult
object
17 properties
AnalysisResultReferences
object
1 property
AnalysisResultShort
object
5 properties 3 required
AnalysisResultStatistics
object
2 properties
AnalysisResultSummary
object
6 properties
AnalysisResultsOverview
object
2 properties 2 required
AnalysisSavings
object
2 properties
AnalyticsInstancesRunResponse
object
2 properties
AnalyticsOverview
object
2 properties 2 required
AnalyticsOverviewItem
object
2 properties 2 required
AnalyticsResultsForComponent
object
3 properties
AnalyticsResultsForComponentResultIds
object
12 properties
AnalyticsResultsForComponents
object
2 properties
ApiDetails
object
2 properties
AssignedPin
object
13 properties
AttributeErrorModel
object
2 properties 2 required
Chat
object
2 properties 1 required
ChatHistory
object
1 property 1 required
ChatPrompt
object
3 properties 1 required
ChatRequest
object
3 properties 2 required
ChatResponse
object
3 properties 2 required
Company
object
8 properties 1 required
CompanyProjectResponse
object
2 properties 2 required
CompanyReference
object
1 property 1 required
CompanyRole
object
5 properties
CompanyWithContext
object
3 properties
Component
object
7 properties
ComponentAttributeDefinition
object
15 properties
ComponentCategory
object
7 properties
ComponentControlsApp
object
7 properties 3 required
ComponentInProject
object
7 properties
ComponentInProjectAttribute
object
6 properties
ComponentInProjectHolidays
object
2 properties 1 required
ComponentInProjectKPIAggregations
object
2 properties 2 required
ComponentInProjectRelation
object
4 properties
ComponentInProjectWithContext
object
14 properties
ComponentSavings
object
3 properties 3 required
ComponentSchedule
object
4 properties
ComponentWithContext
object
6 properties 6 required
ComponentWithResults
object
4 properties
ComponentsInProject
object
2 properties
ComponentsKPIAggregationResult
object
3 properties 3 required
ControlsAlgorithm
object
6 properties 6 required
ControlsAlgorithmCounts
object
2 properties 2 required
ControlsAlgorithmLabel
object
2 properties 2 required
ControlsApp
object
13 properties 7 required
ControlsAppEventStream
object
10 properties 2 required
ControlsAppList
object
2 properties 2 required
ControlsAppPin
object
6 properties
ControlsAppShort
object
9 properties 5 required
ControlsAppStatus
object
4 properties 2 required
ControlsAppUpdateResult
object
3 properties 3 required
ControlsAppVariation
object
3 properties 3 required
ControlsAppsSummary
object
1 property 1 required
ControlsStatistics
object
1 property 1 required
Conversation
object
4 properties 2 required
ConversationEntry
object
6 properties 5 required
ConversationList
object
2 properties
ConversationSource
object
3 properties 3 required
CustomPage
object
3 properties
DashboardNotificationPoint
object
1 property
DataPoint
object
7 properties 2 required
DataPointKey
object
4 properties
DataPointWithContext
object
9 properties
DataPointWithTags
object
2 properties
DatapointWithScore
object
2 properties
DeleteProjectDatapointsRequest
array
DeleteSetpoint
object
1 property 1 required
Device
object
6 properties
DeviceMinimal
object
3 properties
EmailNotificationPoint
object
1 property
Endpoint
object
4 properties
EntityLog
object
4 properties 4 required
EntityLogList
object
2 properties 2 required
EnumValue
object
4 properties
Error
object
4 properties 1 required
EventStreamOutputDatapoint
object
2 properties 1 required
File
object
7 properties
FilesList
object
2 properties
HiddenNativePage
object
1 property 1 required
Holiday
object
2 properties 2 required
ImportDigitalTwinRequest
object
2 properties 2 required
ImportDigitalTwinResponse
object
4 properties
InstanceConfig
object
3 properties
InstanceSummary
object
3 properties
Job
object
7 properties
JobList
object
2 properties
JobLogList
object
2 properties 2 required
KPI
object
8 properties 7 required
KPIAggregationItem
object
2 properties 2 required
KPIAggregationResult
object
4 properties
KPIResult
object
6 properties
KPIResultList
object
1 property
KPIResultShort
object
3 properties
LabelsSystems
object
4 properties
LatestReportGeneration
object
2 properties 2 required
LatestSuccessfulReport
object
2 properties 2 required
ListOfAlerts
object
2 properties
ListOfCompanyRoles
array
ListOfDataPoints
object
4 properties
ListOfDevices
object
3 properties
ListOfEndpoints
array
ListOfRoles
array
MSTeamsNotificationPoint
object
1 property
MqttTopicAuth
object
3 properties
MqttUser
object
5 properties
NewCompanyRole
object
3 properties 2 required
NewComponentInProject
object
4 properties
NewComponentInProjectRelation
object
3 properties 3 required
NewCustomControlsApp
object
1 property 1 required
NewCustomPage
object
2 properties 2 required
NewDiscreteAlert
object
Definitions for a new discrete value alert. - The alert fires while the datapoint's value is one of the values in 'values', and clears as soon as the value is…
12 properties 3 required
NewInstanceConfig
object
6 properties 2 required
NewMqttUser
object
5 properties 2 required
NewProject
object
12 properties 1 required
NewProjectComment
object
1 property 1 required
NewProjectGroup
object
2 properties 1 required
NewRole
3 required
NewSaving
object
6 properties 5 required
NewTag
object
2 properties 1 required
NewTask
object
11 properties 1 required
NewTaskComment
object
1 property 1 required
NewThresholdAlert
object
Definitions for a new threshold alert - When the alert stays on the same level, it is re-notified only after the 'repeat' duration; a 'repeat' of '0s' or 'neve…
10 properties 3 required
NewThroughputAlert
object
Definitions for a new throughput alert. - When the alert stays on the same level, new events are emitted only after the 'repeat' duration. - Throughput is meas…
10 properties 3 required
NewUser
object
9 properties 3 required
Node
object
6 properties
ObjectReportStatus
object
3 properties 1 required
Observation
object
2 properties 2 required
PaginationMeta
object
4 properties 4 required
PatchAttributesErrorDetails
object
2 properties 2 required
PatchAttributesSuccess
object
3 properties 2 required
PatchProjectComponentAttributesRequest
array
PatchedAttribute
object
2 properties
Pin
object
11 properties
PinAttribute
object
4 properties
PinRecommendation
object
3 properties
PlotView
object
6 properties 4 required
PlotViewResponse
object
7 properties 4 required
PlotViewZoom
object
Plot view zoom period with start and end timestamps including timezone
2 properties
PlotsResult
object
7 properties
PlotsResultData
object
2 properties
PortfolioResult
object
3 properties 2 required
PostControlsAppRequest
object
1 property
PostProjectComponentAttributeRequest
object
3 properties 2 required
PostProjectImportTimeseriesRequest
object
1 property 1 required
PostProjectTimeseriesRequest
object
PostProjectVirtualDatapointRequest
object
2 properties 2 required
Project
object
21 properties 2 required
ProjectComment
object
6 properties 1 required
ProjectCommentList
object
2 properties
ProjectGroup
object
3 properties 3 required
ProjectJourney
object
2 properties
ProjectJourneyAction
object
2 properties 2 required
ProjectJourneyMilestone
object
4 properties
ProjectJourneyOverview
object
1 property
ProjectJourneyPhase
object
2 properties
ProjectJourneySubstage
object
6 properties
ProjectJourneySyncResponse
object
2 properties
ProjectKPI
object
6 properties 4 required
ProjectKPIAggregationResultItem
object
5 properties 2 required
ProjectLink
object
9 properties 6 required
ProjectPortfolio
object
11 properties 4 required
ProjectSetupCredential
object
2 properties 2 required
ProjectSetupResource
object
3 properties 2 required
ProjectSetupResponse
object
2 properties 2 required
ProjectSetupTopic
object
2 properties 2 required
ProjectShort
object
2 properties
ProjectWithContext
object
3 properties
ProjectsKPIAggregation
object
4 properties 4 required
PutProjectVirtualDatapointRequest
object
1 property
PutUserPasswordRequest
object
2 properties 2 required
Quota
object
4 properties
Quotas
object
3 properties
RealmRole
object
3 properties
Renaming
object
3 properties
Role
object
6 properties
Saving
object
7 properties
SavingsPotential
object
5 properties 4 required
Schedule
object
6 properties
Setpoint
object
3 properties 3 required
SetpointAck
object
8 properties
SetpointReference
object
8 properties
SetpointReferences
object
2 properties
ShortUser
object
6 properties 3 required
ShortUserList
object
2 properties
SignalColorCountOverview
object
4 properties 4 required
Source
object
2 properties 2 required
Success
object
4 properties
SummaryKPICurrentResult
object
3 properties
SummaryKPIDevelopmentResult
object
4 properties
SummaryKPIResult
object
2 properties
Tag
object
3 properties 2 required
TagAssociation
TagAuth
object
4 properties
Task
object
16 properties
TaskComment
object
6 properties 1 required
TaskCommentList
object
2 properties
TaskList
object
2 properties
TaskStatistics
object
2 properties 2 required
TelegramNotificationPoint
object
1 property
TimeRangeInfo
object
3 properties
Timeseries
array
TimeseriesResult
object
3 properties
TimeseriesWithContext
object
6 properties
TotalSavings
object
5 properties 1 required
UpdateAlert
object
Partial update for an existing alert. Only the provided fields are changed; omitted fields keep their current values. The monitored datapoint (dataPointID), th…
12 properties
UpdateCompany
object
3 properties
UpdateCompanyRole
object
3 properties
UpdateDatapoint
object
3 properties
UpdateInstanceConfig
object
6 properties
UpdateMqttUser
object
4 properties
UpdateProject
object
12 properties
UpdateProjectComment
object
1 property 1 required
UpdateProjectGroup
object
1 property 1 required
UpdateRole
UpdateSaving
object
4 properties
UpdateSetpoint
object
3 properties 1 required
UpdateTag
object
2 properties
UpdateTagAssoc
object
1 property
UpdateTask
object
11 properties 5 required
UpdateTaskComment
object
1 property 1 required
UpdateUser
object
8 properties
UploadAvatarRequest
object
1 property 1 required
UploadFileRequest
object
1 property 1 required
User
object
12 properties
UserProjectsPortfolio
object
1 property
UserWithContext
object
6 properties
VirtualDatapoint
object
7 properties
VirtualDatapointList
object
2 properties
VirtualDatapointShort
object
2 properties
VirtualDatapointStatus
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aedifion-openapi.yml Raw ↑
#Building Automation#Smart Buildings#Energy Management#Time Series#Analytics#Internet of Things#HVAC
← Back to A APIs
API Details
ID
aedifion:aedifion-http-api
Base URL
https://api.aedifion.io
Docs
https://docs.aedifion.io/en/developers/http-api/
Provider
Aedifion
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aedifion-aedifion-http-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aedifion-aedifion-http-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of aedifion HTTP API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.