API Documentation

v1.4.2 Stable

The Aevum Zenth API provides secure, programmatic access to cross-divisional data, analytics, compliance systems, and operational tools. Built for developers, enterprises, and partners.

Base URL: https://api.aevumzenth.io/v1

All endpoints return JSON. Requests require valid API authentication. See Authentication for setup.

Quick Start

Generate your API key from the Developer Dashboard. Include it in every request header.

cURL

curl -X GET "https://api.aevumzenth.io/v1/divisions" \ 
  -H "Authorization: Bearer az_live_8xK2mP9qR7vN4wL5" \ 
  -H "Content-Type: application/json"

Authentication

Aevum Zenth uses Bearer tokens and API keys. Include your key in the Authorization or X-AZ-API-Key header.

Header	Value Format	Description
Authorization	Bearer	Standard OAuth2 / API Key format
X-AZ-API-Key	String	Legacy compatibility header

Sandbox vs Production: Sandbox keys prefix with az_sandbox_ and route to isolated test environments. Production keys prefix with az_live_.

Divisions Endpoint

Access metadata, operational status, and cross-divisional routing information.

GET /divisions List all active divisions

Returns a paginated array of division objects including IDs, names, operational status, and API capabilities.

Query Parameters

page optional	integer	Pagination page number (default: 1)
limit optional	integer	Items per page (max: 100)
status optional	string	Filter by status: `active`, `limited`, `maintenance`

Response Example

JSON

{
  "data": [
    {
      "id": "div_energy_01",
      "name": "Aevum Energy & Power",
      "status": "active",
      "api_version": "2.1.0",
      "endpoints_available": 42
    }
  ],
  "meta": { "total": 127, "page": 1 }
}

Data Queries

Execute structured queries across unified data lakes. Supports JSON, GraphQL, and CSV export formats.

POST /data/query Execute cross-divisional data query

Submit a query payload to retrieve aggregated or filtered datasets. Requires data:read scope.

Request Body

JSON

{
  "divisions": ["div_energy_01", "div_logistics_04"],
  "date_range": { "start": "2026-01-01", "end": "2026-06-30" },
  "metrics": ["throughput", "efficiency"],
  "format": "json"
}

Analytics & Metrics

Real-time and historical performance data across all operational verticals.

GET /analytics/revenue Fetch aggregated revenue metrics

Returns time-series revenue data. Supports daily, weekly, monthly, and quarterly intervals.

Compliance & Legal

Manage regulatory flags, audit logs, and jurisdictional compliance status.

PUT /compliance/status Update regulatory compliance flags

Requires compliance:write scope. Changes are logged and subject to automated audit reviews.

Rate Limits

API access is tiered by subscription level. Exceeding limits returns 429 Too Many Requests.

Plan	Requests/Min	Concurrency	Burst Allowance
Standard	1,000	5	2,500
Professional	5,000	25	12,500
Enterprise	25,000	100	Unlimited

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with machine-readable codes.

Code	Meaning	Resolution
400	Bad Request	Check payload structure and required fields
401	Unauthorized	Verify API key and token validity
403	Forbidden	Request requires higher scope/permissions
429	Rate Limited	Wait and retry with exponential backoff
500	Server Error	Transient issue; contact support if persistent

SDKs & Libraries

Official client libraries are available for Python, JavaScript, Go, and Java. Community packages are welcome via our GitHub org.

npm

npm install @aevum-zenth/api-client