Skip to content

Local API

Software on the PC, or on your private network, can read BUSY data through the AI Zeny Windows app directly, without AI Zeny Cloud.

When to use it

Use the Local API when the software that needs BUSY data runs on the PC or your own network. Use the public API when it runs anywhere else.

Addresses, token and scope

  • It listens on the PC’s own address and its local network address, on port 8801 by default.
  • It answers only loopback and private local-network addresses; anything else is refused with 403 LOCAL_NETWORK_ONLY.
  • The Windows firewall rule admits the Local API port for the local subnet only, on Domain and Private profiles — never Public.
  • Each PC has one Local API token, generated on the PC and shown in the app after unlock. It never comes from or goes to the cloud and is not the organization API token. Regenerating it stops the old one at once.

Same operations, same envelope

The Local API answers the same operations with the same { success, data, metadata } envelope; routes that carry saved settings may add a configuration member. Its paths carry a prefix of their own before the version, which the public API does not; the Local API documentation in the Windows app describes them.

Local-only refusals include 401 UNAUTHORIZED, 403 LOCAL_NETWORK_ONLY and 503 HOST_STOPPING.