Skip to main content

Available Tools

ToolEndpointDescription
get_consumptionsGET /api/v1/consumptionsConsumption records with filters
get_consumptionGET /api/v1/consumptions/{id}Single consumption record
get_consumptions_dashboardGET /api/v1/consumptions/dashboardAggregated consumption summary

Usage Examples

"Show me electricity consumption for January 2024"
→ get_consumptions({ companyId: "uuid", categoryId: "electricity-uuid", startDate: "2024-01-01", endDate: "2024-01-31" })

"Give me the details of consumption ID X"
→ get_consumption({ id: "consumption-uuid" })

"What is our total consumption by category this year?"
→ get_consumptions_dashboard({ companyId: "uuid", startDate: "2024-01-01", endDate: "2024-12-31" })

Common Parameters

get_consumptions

ParameterTypeDescription
companyIdstringCompany ID (required)
startDatestringStart date (ISO 8601)
endDatestringEnd date (ISO 8601)
categoryIdsstring[]Filter by categories
buildingIdsstring[]Filter by buildings
pageintegerPage number
limitintegerResults per page

get_consumptions_dashboard

ParameterTypeDescription
companyIdstringCompany ID (required)
startDatestringStart date
endDatestringEnd date
categoryIdsstring[]Filter by categories
buildingIdsstring[]Filter by buildings