API Integration

BuEM exposes a REST API that receives GeoJSON building descriptions and returns thermal-load results. This section explains the endpoints, payload formats, and Docker setup needed to integrate BuEM with other models.

• Docker Setup
  • Quick Start
  • Environment Variables
  • Volume Mounts
  • Manual Build
  • Health Check
  • Troubleshooting
  • Next Steps
• API Endpoints
  • POST /api/process
  • POST /api/run
  • GET /api/files/<filename>
  • GET /api/health
  • GET /api/docs
  • GET /api/openapi.yaml
  • Error Responses
• Request Data Format
  • GeoJSON Structure
  • Required Fields
  • Building Attributes Structure
  • Component Types
  • Optional Configuration
  • Complete Example
  • Validation Rules
  • Next Steps
• Response Format
  • Top-Level Response
  • Thermal Load Profile
  • Timeseries File
  • Feature-Level Errors
• Error Handling
  • HTTP Status Codes
  • Error Categories
  • Debugging Checklist
  • Error Recovery Strategies
  • Production Considerations
  • Next Steps
• Integration Examples
  • Starting the Server
  • Health Check
  • Process a GeoJSON File
  • Python Helper
  • Minimal Python Client
  • Downloading Time-Series Files
  • Result Forwarding
  • Environment Variables