API Documentation

The Aevum Zenth API provides programmatic access to our multidivisional enterprise data, logistics networks, analytics engines, and subsidiary management systems. Designed for developers, partners, and internal systems.

Quick Example
GET https://api.aevumzenth.com/v1/divisions
Headers: {
  "Authorization": "Bearer <YOUR_API_KEY>",
  "Content-Type": "application/json"
}

Base URL

All API requests should be made to the following base URL:

Production
https://api.aevumzenth.com/v1

Sandbox environment for testing:

Sandbox
https://sandbox.api.aevumzenth.com/v1

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header for every request.

Generate API keys in the Developer Portal. Keys are scoped by division and access level.

Authentication Header
Authorization: Bearer az_live_8f3k29d1m4p7x2q5w8z9
X-AZ-Tenant: your-company-id

⚠️ Never expose secret keys in client-side code or public repositories.

Endpoints

GET /divisions

Retrieve a paginated list of all active corporate divisions and their metadata.

Query Parameters

Parameter Type Description
page Optional integer Page number for pagination (default: 1)
limit Optional integer Results per page (max: 100, default: 20)
status Optional string Filter by status: active, inactive, acquiring

Response

200 OK
{
  "data": [
    {
      "id": "div_energy_global",
      "name": "Aevum Energy & Power",
      "sector": "Renewables & Grid Infrastructure",
      "status": "active",
      "revenue_ttm": 14200000000
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 21,
    "total_items": 400
  }
}
GET /subsidiaries/:id/financials

Fetch detailed financial statements and quarterly reports for a specific subsidiary.

Path Parameters

Parameter Type Description
id Required string Unique subsidiary identifier (e.g., sub_zenth_health_04)

Query Parameters

Parameter Type Description
period Optional string Fiscal period: Q1, Q2, Q3, Q4, annual
year Optional integer Fiscal year (default: current)
POST /analytics/query

Submit custom analytical queries across divisional datasets. Returns structured metrics, forecasts, and cross-sector correlations.

Request Body

Parameter Type Description
query_type Required string Query category: revenue, operational, logistics, predictive
scope Required array[string] Division IDs or region codes to include
metrics Required array[string] Requested data points (e.g., gross_margin, carbon_output)
time_range Optional object start and end ISO 8601 timestamps

Request Example

POST Body
{
  "query_type": "predictive",
  "scope": ["div_aerospace", "div_robotics"],
  "metrics": ["production_efficiency", "supply_chain_latency"],
  "time_range": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-12-31T23:59:59Z"
  }
}
PUT /logistics/routes/:route_id

Update autonomous freight routing parameters, customs clearances, and priority tiers for active supply chains.

Path Parameters

Parameter Type Description
route_id Required string Unique logistics corridor identifier (e.g., rt_asia_eu_maritime_09)

Request Body

Parameter Type Description
priority Optional string standard, expedited, critical
customs_override Optional boolean Bypass standard clearance for diplomatic/essential cargo

Error Codes

The API uses standard HTTP status codes and returns detailed error objects in the response body.

400 Bad Request
Invalid syntax, missing required parameters, or malformed payload.
401 Unauthorized
Missing or invalid API key. Check your Authorization header.
403 Forbidden
Valid token but insufficient permissions for this endpoint.
404 Not Found
Resource does not exist or has been decommissioned.
429 Too Many Requests
Rate limit exceeded. Review headers for retry window.
500 Internal Error
Unexpected server-side failure. Contact engineering if persistent.

Error Response Format

Error Object
{
  "error": {
    "code": "invalid_scope",
    "message": "Requested division outside tenant access boundaries.",
    "status": 403,
    "request_id": "req_7x92m4k1p8",
    "docs_url": "https://docs.aevumzenth.com/errors/403"
  }
}

Rate Limits

API access is governed by tier-based rate limiting to ensure system stability and fair usage across the enterprise network.

Plan Requests / Minute Burst Limit Data Access
Standard 1,000 150 Public & Partner Divisions
Enterprise 5,000 500 All Divisions + Analytics Engine
Internal 25,000 2,000 Full Access + Real-time Streams

Rate limit information is returned in response headers:

Rate Limit Headers
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4823
X-RateLimit-Reset: 1735689600
Retry-After: 14