⚡ AI-tility API
v1.0.0
System Operational
Go to Dashboard
AI-tility API Reference
Welcome to the AI-tility API documentation. Our API allows you to programmatic access to utility services, customer data, and smart meter usage statistics.
🔐
Authentication
Session-based (Cookies). Log in to the dashboard to authenticate.
📡
Base URL
http://aitility.devrev.community/api
Services & Operations
No Auth Required
GET
/api/services
Response Schema
[
{
"id": "gas",
"name": "Natural Gas",
"description": "Reliable and clean natural gas...",
"price_unit": "per m3",
"price": 1.5
},
...
]
Try It Out
GET
/api/services/{service_id}
Parameters
Try It Out
POST
/api/orders
Request Body
{
"service_id": "gas",
"customer_name": "Jane Doe",
"customer_email": "jane@example.com",
"amount": 100.0
}
Try It Out
POST
/api/support
Request Body
Try It Out
⚠️
You are not logged in. Private endpoints below will return 401 Unauthorized.
Log in here to test them.
User & Account
Auth Required
GET
/api/user/me
GET
/api/user/plug-identity
Contracts & Usage
Auth Required
GET
/api/user/contracts
POST
/api/user/contracts
Request Body
{
"service_type": "water",
"contract_type": "fixed",
"monthly_installment": 20.00
}
Try It Out
DELETE
/api/user/contracts/{contract_id}
Parameters
Try It Out
PUT
/api/user/contracts/{contract_id}
Parameters & Body
{
"contract_type": "fixed",
"monthly_installment": 45.00
}
Try It Out
GET
/api/user/usage/{utility_type}
Parameters
Try It Out
GET
/api/user/meter-readings
POST
/api/user/meter-readings
Request Body
{
"service_type": "electricity",
"reading_date": "2024-03-15",
"reading_value": 12500.50,
"unit": "kWh"
}
Try It Out
Billing
Auth Required
GET
/api/invoices
GET
/api/invoices/{invoice_id}
Parameters
Use an ID from the "Invoices" endpoint above.
Try It Out
PUT
/api/invoices/{invoice_id}/status
Parameters
Try It Out
Remote Control
Auth Required
POST
/api/control/open_invoice_modal
Parameters
Note: Dashboard must be open in another tab/window for this to work.
Try It Out
POST
/api/control/open_contract_modal
Parameters
Note: Dashboard must be open in another tab/window for this to work.