generators

Estimate a device's electrical specs from a free-text description (AI)

Used by the wireframe editor's add-load dialog. Calls the external OpenRouter chat-completions API (https://openrouter.ai) with the model configured server-side in OPENROUTER_LOAD_ASSISTANT_MODEL; 20 s timeout. 20 requests per hour per client IP. The client IP is the first X-Forwarded-For entry, else X-Real-IP, else one shared unknown bucket; counters are kept in memory per server instance and per route. No CORS headers.

post/api/loads/estimate

Request

  • Base URL: https://voltplan.app
  • URL: https://voltplan.app/api/loads/estimate
  • Auth: none declared

Request body

descriptionstring required

Free-text description; the length is checked after trimming.

Response

Parsed estimate.

namestring required
wattnumber required

Nominal running power in W.

wattMinnumber

Lower bound of the plausible running power in W.

wattMaxnumber

Upper bound of the plausible running power in W.

category'resistive' | 'electronics' | 'fridge' | 'motor' | 'pump'
notestring
dutyCyclenumber

Percent of switched-on time the compressor/motor actually draws power.

utilizationFactornumber

Percent of a day the device is switched on.

Changes

No recorded changes to this operation across all 1 revision of this API.