{"openapi":"3.1.0","info":{"title":"Meter (BYOK) API","version":"0.1.0","description":"Meter (BYOK) lets an AI assistant read your own Meter data through the Meter API with a key you supply (Meter API key). Read-only: 9 tools (get_company, list_networks, get_network, list_devices, get_device, get_hardware_device, list_spare_devices, list_vlans, list_ssids). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-meter.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-meter/docs"},"termsOfService":"https://connectorbay.com/byok-meter/terms"},"servers":[{"url":"https://byok-meter.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-meter/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/get_company":{"post":{"operationId":"get_company","summary":"Get one company by slug with its name, website domain and whether it is a customer. Use for \"What is the Meter company a","description":"Get one company by slug with its name, website domain and whether it is a customer. Use for \"What is the Meter company acme\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"company_slug":{"description":"Company slug as shown in the Meter dashboard URL, for example acme.","maxLength":200,"title":"Company Slug","type":"string"}},"required":["company_slug"],"title":"get_companyArguments","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_networks":{"post":{"operationId":"list_networks","summary":"List all networks (sites) of a company with label, slug, active state and go-live date. Use for \"Which Meter networks do","description":"List all networks (sites) of a company with label, slug, active state and go-live date. Use for \"Which Meter networks does acme have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"company_slug":{"description":"Company slug as shown in the Meter dashboard URL, for example acme.","maxLength":200,"title":"Company Slug","type":"string"}},"required":["company_slug"],"title":"list_networksArguments","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_network":{"post":{"operationId":"get_network","summary":"Get one network by company slug and network slug with active state and key dates. Use for \"Is the Meter network hq of ac","description":"Get one network by company slug and network slug with active state and key dates. Use for \"Is the Meter network hq of acme active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"company_slug":{"description":"Company slug as shown in the Meter dashboard URL, for example acme.","maxLength":200,"title":"Company Slug","type":"string"},"network_slug":{"description":"Network slug from list_networks, for example hq.","maxLength":200,"title":"Network Slug","type":"string"}},"required":["company_slug","network_slug"],"title":"get_networkArguments","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_devices":{"post":{"operationId":"list_devices","summary":"List the devices (access points, switches, firewalls, observers) of a network with label, type, model, online state, upt","description":"List the devices (access points, switches, firewalls, observers) of a network with label, type, model, online state, uptime and hardware serial number. Use for \"Which Meter devices are online in the hq network\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network_uuid":{"description":"Network UUID from list_networks.","maxLength":200,"title":"Network Uuid","type":"string"}},"required":["network_uuid"],"title":"list_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_device":{"post":{"operationId":"get_device","summary":"Get one device by virtual device UUID with type, model, online state, uptime and its hardware serial number. Use for \"Is","description":"Get one device by virtual device UUID with type, model, online state, uptime and its hardware serial number. Use for \"Is the Meter device Lobby AP online\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"virtual_device_uuid":{"description":"Virtual device UUID from list_devices.","maxLength":200,"title":"Virtual Device Uuid","type":"string"}},"required":["virtual_device_uuid"],"title":"get_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_hardware_device":{"post":{"operationId":"get_hardware_device","summary":"Look up a physical Meter device by serial number: model, type, whether it is connected to the Meter backend, since when ","description":"Look up a physical Meter device by serial number: model, type, whether it is connected to the Meter backend, since when it is disconnected and the network it belongs to. Use for \"Is the Meter hardware MTR-AP-0001 connected\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"serial_number":{"description":"Hardware serial number printed on the device or returned by list_devices.","maxLength":200,"title":"Serial Number","type":"string"}},"required":["serial_number"],"title":"get_hardware_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/list_spare_devices":{"post":{"operationId":"list_spare_devices","summary":"List the spare hardware devices of a network: owned by the network but not assigned to any configured device. Use for \"W","description":"List the spare hardware devices of a network: owned by the network but not assigned to any configured device. Use for \"Which spare Meter hardware does the hq network have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network_uuid":{"description":"Network UUID from list_networks.","maxLength":200,"title":"Network Uuid","type":"string"}},"required":["network_uuid"],"title":"list_spare_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/list_vlans":{"post":{"operationId":"list_vlans","summary":"List the VLANs of a network with VLAN id, name, enabled and default flags and the client IPv4 prefix length. Use for \"Wh","description":"List the VLANs of a network with VLAN id, name, enabled and default flags and the client IPv4 prefix length. Use for \"Which VLANs does the Meter hq network have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network_uuid":{"description":"Network UUID from list_networks.","maxLength":200,"title":"Network Uuid","type":"string"}},"required":["network_uuid"],"title":"list_vlansArguments","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_ssids":{"post":{"operationId":"list_ssids","summary":"List the Wi-Fi networks (SSIDs) of a network with name, encryption protocol, enabled, guest and hidden flags and allowed","description":"List the Wi-Fi networks (SSIDs) of a network with name, encryption protocol, enabled, guest and hidden flags and allowed bands. Wi-Fi passwords are not requested. Use for \"Which SSIDs does the Meter hq network broadcast\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network_uuid":{"description":"Network UUID from list_networks.","maxLength":200,"title":"Network Uuid","type":"string"}},"required":["network_uuid"],"title":"list_ssidsArguments","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}}}}