{"openapi":"3.1.0","info":{"title":"EnergyCAP Groups (BYOK) API","version":"0.1.0","description":"EnergyCAP Groups (BYOK) lets an AI assistant read your own EnergyCAP Groups data through the EnergyCAP Groups API with a key you supply (EnergyCAP API key). Read-only: 8 tools (list_meter_groups, list_meter_group_categories, list_meter_group_members, list_place_groups, list_place_group_categories, list_place_group_members, list_routes, get_route_details). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-energycap-groups.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-energycap-groups/docs"},"termsOfService":"https://connectorbay.com/byok-energycap-groups/terms"},"servers":[{"url":"https://byok-energycap-groups.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-energycap-groups/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_meter_groups":{"post":{"operationId":"list_meter_groups","summary":"List meter groups (for example by building type or commodity) with category, member count and whether the group is autom","description":"List meter groups (for example by building type or commodity) with category, member count and whether the group is automatic. Use for \"Which meter groups exist in EnergyCAP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":400,"type":"string"},{"type":"null"}],"default":null,"description":"Narrow the meter groups. Filter expression: field operator 'value' pairs joined by and, every value in single quotes, operators such as equals, not equals, like, one of ('a'|'b'), between ('a'|'b'), greater than, less than. Example: autoGroup equals 'true'.","title":"Filter"}},"title":"list_meter_groupsArguments","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_meter_group_categories":{"post":{"operationId":"list_meter_group_categories","summary":"List meter group categories with the number of groups in each. Use for \"What meter group categories are there\".","description":"List meter group categories with the number of groups in each. Use for \"What meter group categories are there\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_meter_group_categoriesArguments","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_meter_group_members":{"post":{"operationId":"list_meter_group_members","summary":"List the meters in one meter group with code, commodity, type, place and charting flag. Use for \"Which meters are in met","description":"List the meters in one meter group with code, commodity, type, place and charting flag. Use for \"Which meters are in meter group 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"meter_group_id":{"description":"Numeric meter group ID, for example 12 (from list_meter_groups).","minimum":1,"title":"Meter Group Id","type":"integer"},"always_limit_by_topmost":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"When true, only members inside the key owner's topmost place are listed, whatever the group setting says.","title":"Always Limit By Topmost"}},"required":["meter_group_id"],"title":"list_meter_group_membersArguments","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_place_groups":{"post":{"operationId":"list_place_groups","summary":"List place groups (for example buildings by use or region) with category, member count and whether the group is automati","description":"List place groups (for example buildings by use or region) with category, member count and whether the group is automatic. Use for \"Which place groups exist in EnergyCAP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":400,"type":"string"},{"type":"null"}],"default":null,"description":"Narrow the place groups. Filter expression: field operator 'value' pairs joined by and, every value in single quotes, operators such as equals, not equals, like, one of ('a'|'b'), between ('a'|'b'), greater than, less than. Example: autoGroup equals 'false'.","title":"Filter"}},"title":"list_place_groupsArguments","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_place_group_categories":{"post":{"operationId":"list_place_group_categories","summary":"List place group categories with the number of groups in each. Use for \"What place group categories are there\".","description":"List place group categories with the number of groups in each. Use for \"What place group categories are there\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_place_group_categoriesArguments","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_place_group_members":{"post":{"operationId":"list_place_group_members","summary":"List the places in one place group with code, name, type, parent and charting flag. Use for \"Which places are in place g","description":"List the places in one place group with code, name, type, parent and charting flag. Use for \"Which places are in place group 8\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place_group_id":{"description":"Numeric place group ID, for example 8 (from list_place_groups).","minimum":1,"title":"Place Group Id","type":"integer"},"always_limit_by_topmost":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"When true, only members inside the key owner's topmost place are listed, whatever the group setting says.","title":"Always Limit By Topmost"}},"required":["place_group_id"],"title":"list_place_group_membersArguments","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_routes":{"post":{"operationId":"list_routes","summary":"List meter-reading routes with the number of meters on each. Use for \"Which meter reading routes exist\".","description":"List meter-reading routes with the number of meters on each. Use for \"Which meter reading routes exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_routesArguments","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_route_details":{"post":{"operationId":"get_route_details","summary":"Get one meter-reading route with its ordered meters, serial numbers, commodity and place. Use for \"Show the meters on ro","description":"Get one meter-reading route with its ordered meters, serial numbers, commodity and place. Use for \"Show the meters on route 4\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"route_id":{"description":"Numeric route ID, for example 4 (from list_routes).","minimum":1,"title":"Route Id","type":"integer"}},"required":["route_id"],"title":"get_route_detailsArguments","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}}}}