Skip to content
AI Zeny
Sign inStart Free Trial

Free trial · no card or payment details · Pro-level features, without the AI Agent

Developers

API version 1 overview

Version 1 is the current published contract of the AI Zeny public API.

Base URL

Calls go to https://api.aizeny.com/v1/…. The version is the first path segment and there is no other prefix. An unknown version answers 404 API_VERSION_UNKNOWN and is never redirected to another version.

https://api.aizeny.com/v1

How a request is answered

A BUSY request is relayed to your organization’s enrolled PC and answered by the AI Zeny Windows app with the same code as its Local API. AI Zeny Cloud keeps no copy of the data a relayed request carries.

Every BUSY operation is a POST and a read, takes the organization token and nothing else, and requires companyCode and a four-digit financialYear. Defaults are applied by the PC, never by the cloud.

The response envelope

Every answer, success or failure, on every route, is one JSON object with three members in this order: success, data and metadata.

  • data is exactly what the PC read: a list is an array, a report is an object.
  • metadata.requestId always equals the X-Request-Id response header.
  • An error has metadata.error { code, message }, plus field when one member was refused, retryable: true when a retry after Retry-After may succeed, and details for extra machine-readable facts.
  • Numbers are exact: an amount the PC reports as 12.50 is returned digit for digit.

Next

See the operation families, the error codes, the limits and the changelog.