{"openapi":"3.1.0","info":{"title":"GivEnergy (BYOK) API","version":"0.1.0","description":"GivEnergy (BYOK) lets an AI assistant read your own GivEnergy data through the GivEnergy API with a key you supply (API token). Read-only: 12 tools (list_communication_devices, get_communication_device, get_latest_system_data, get_latest_energy_data, list_inverter_events, list_inverter_data_points, get_inverter_health, list_sites, get_site_energy_data, get_site_system_data, list_ev_chargers,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-givenergy.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-givenergy/docs"},"termsOfService":"https://connectorbay.com/byok-givenergy/terms"},"servers":[{"url":"https://byok-givenergy.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-givenergy/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_communication_devices":{"post":{"operationId":"list_communication_devices","summary":"List the Wi-Fi dongles and gateways on the account with their inverter serial, status, last online time, model, battery ","description":"List the Wi-Fi dongles and gateways on the account with their inverter serial, status, last online time, model, battery type and firmware. Needs a GivEnergy Premium subscription. Use for \"Which GivEnergy inverters do I have and are they online\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"title":"list_communication_devicesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_communication_device":{"post":{"operationId":"get_communication_device","summary":"Get one communication device by its serial number, with the attached inverter's status, model and battery details. Needs","description":"Get one communication device by its serial number, with the attached inverter's status, model and battery details. Needs a GivEnergy Premium subscription. Use for \"Show details of GivEnergy dongle WF2345G123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"serial_number":{"description":"Communication device (dongle) serial number, for example 'WF2345G123'.","maxLength":200,"title":"Serial Number","type":"string"}},"required":["serial_number"],"title":"get_communication_deviceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_latest_system_data":{"post":{"operationId":"get_latest_system_data","summary":"Get the inverter's latest live reading: solar, grid, battery percentage and power, inverter and house consumption in wat","description":"Get the inverter's latest live reading: solar, grid, battery percentage and power, inverter and house consumption in watts. Needs a GivEnergy Premium subscription. Use for \"What is my GivEnergy battery level and solar output right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inverter_serial_number":{"description":"Inverter serial number, for example 'CE2345G123' (list_communication_devices shows it).","maxLength":200,"title":"Inverter Serial Number","type":"string"}},"required":["inverter_serial_number"],"title":"get_latest_system_dataArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_latest_energy_data":{"post":{"operationId":"get_latest_energy_data","summary":"Get the inverter's latest energy totals for today and lifetime in kWh: solar, grid import and export, battery charge and","description":"Get the inverter's latest energy totals for today and lifetime in kWh: solar, grid import and export, battery charge and discharge, consumption. Needs a GivEnergy Premium subscription. Use for \"How much solar did my GivEnergy system generate today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inverter_serial_number":{"description":"Inverter serial number, for example 'CE2345G123' (list_communication_devices shows it).","maxLength":200,"title":"Inverter Serial Number","type":"string"}},"required":["inverter_serial_number"],"title":"get_latest_energy_dataArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_inverter_events":{"post":{"operationId":"list_inverter_events","summary":"List faults the inverter raised and when they cleared; open ones have no end time. Optionally include cleared events and","description":"List faults the inverter raised and when they cleared; open ones have no end time. Optionally include cleared events and a date range. Needs a GivEnergy Premium subscription. Use for \"Has my GivEnergy inverter reported any faults\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inverter_serial_number":{"description":"Inverter serial number, for example 'CE2345G123' (list_communication_devices shows it).","maxLength":200,"title":"Inverter Serial Number","type":"string"},"cleared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include events that have already cleared (default false).","title":"Cleared"},"start":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start date, format YYYY-MM-DD; must be before tomorrow.","title":"Start"},"end":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End date, format YYYY-MM-DD; must be after start.","title":"End"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"required":["inverter_serial_number"],"title":"list_inverter_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_inverter_data_points":{"post":{"operationId":"list_inverter_data_points","summary":"List the inverter's recorded data points for one day (solar, grid, battery, consumption and daily totals), paginated. Ne","description":"List the inverter's recorded data points for one day (solar, grid, battery, consumption and daily totals), paginated. Needs a GivEnergy Premium subscription. Use for \"Show my GivEnergy inverter readings for 2025-06-01\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inverter_serial_number":{"description":"Inverter serial number, for example 'CE2345G123' (list_communication_devices shows it).","maxLength":200,"title":"Inverter Serial Number","type":"string"},"date":{"description":"Local date, format YYYY-MM-DD.","maxLength":200,"title":"Date","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"required":["inverter_serial_number","date"],"title":"list_inverter_data_pointsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_inverter_health":{"post":{"operationId":"get_inverter_health","summary":"Get the inverter's health checks (import/export power, grid voltage, battery voltage) with value, unit and ok or warning","description":"Get the inverter's health checks (import/export power, grid voltage, battery voltage) with value, unit and ok or warning status. Needs a GivEnergy Premium subscription. Use for \"Is my GivEnergy inverter healthy\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inverter_serial_number":{"description":"Inverter serial number, for example 'CE2345G123' (list_communication_devices shows it).","maxLength":200,"title":"Inverter Serial Number","type":"string"}},"required":["inverter_serial_number"],"title":"get_inverter_healthArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sites":{"post":{"operationId":"list_sites","summary":"List your GivEnergy sites with country, time zone, type and the products (inverters, batteries, meters) installed (coord","description":"List your GivEnergy sites with country, time zone, type and the products (inverters, batteries, meters) installed (coordinates are not returned). Needs a GivEnergy Premium subscription. Use for \"Which GivEnergy sites do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"title":"list_sitesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_site_energy_data":{"post":{"operationId":"get_site_energy_data","summary":"Get the latest energy totals for a whole site (today and lifetime kWh). Needs a GivEnergy Premium subscription. Use for ","description":"Get the latest energy totals for a whole site (today and lifetime kWh). Needs a GivEnergy Premium subscription. Use for \"How much energy did my whole GivEnergy site produce today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_plant_id":{"description":"Numeric site (plant) id from list_sites.","title":"Site Plant Id","type":"integer"}},"required":["site_plant_id"],"title":"get_site_energy_dataArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_site_system_data":{"post":{"operationId":"get_site_system_data","summary":"Get the latest live reading aggregated across a whole site: grid power, battery percentage and generation. Needs a GivEn","description":"Get the latest live reading aggregated across a whole site: grid power, battery percentage and generation. Needs a GivEnergy Premium subscription. Use for \"What is my whole GivEnergy site doing right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_plant_id":{"description":"Numeric site (plant) id from list_sites.","title":"Site Plant Id","type":"integer"}},"required":["site_plant_id"],"title":"get_site_system_dataArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_ev_chargers":{"post":{"operationId":"list_ev_chargers","summary":"List your GivEnergy EV chargers with alias, online flag and current status. Needs a GivEnergy Premium subscription. Use ","description":"List your GivEnergy EV chargers with alias, online flag and current status. Needs a GivEnergy Premium subscription. Use for \"Is my GivEnergy EV charger online\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"title":"list_ev_chargersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_charging_sessions":{"post":{"operationId":"list_charging_sessions","summary":"List an EV charger's charging sessions with start and stop time, meter readings and stop reason. Needs a GivEnergy Premi","description":"List an EV charger's charging sessions with start and stop time, meter readings and stop reason. Needs a GivEnergy Premium subscription. Use for \"Show recent GivEnergy EV charging sessions\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"charger_uuid":{"description":"EV charger UUID from list_ev_chargers.","maxLength":200,"title":"Charger Uuid","type":"string"},"start_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions starting at or after this date or time, ISO 8601.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions up to this date or time, ISO 8601.","title":"End Time"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":15,"description":"Items per page (default 15).","title":"Page Size"}},"required":["charger_uuid"],"title":"list_charging_sessionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}