API & Documentation

Comprehensive API reference for Aevum Zenth's integrated enterprise platform. Access data, automate workflows, and integrate with our 400+ subsidiaries.

🔑

Authentication

OAuth 2.0 and API key authentication with role-based access control across all divisions.

⚡

REST & GraphQL

Full REST API with GraphQL support for flexible, efficient data queries across all endpoints.

📦

SDKs Available

Official SDKs for Python, JavaScript, Go, Java, Ruby, and C# with full type support.

🔔

Webhooks

Real-time event notifications for subsidiary updates, operational changes, and data events.

Base URL:

Quick Start

Get up and running with the Aevum Zenth API in three simple steps.

1. Obtain Your API Key

Register at developer.aevumzenth.com and generate an API key from your dashboard. Choose between production or sandbox environments.

2. Make Your First Request

curl https://api.aevumzenth.com/v3/entities \\
  -H "Authorization: Bearer az_live_sk_your_api_key_here" \\
  -H "Content-Type: application/json"
import aevum_zenth

client = aevum_zenth.Client(api_key="az_live_sk_your_api_key_here")

# List all entities
entities = client.entities.list(
    division="energy",
    status="active",
    limit=20
)

for entity in entities:
    print(entity.name, entity.id)
const { AevumClient } = require("@aevum-zenth/sdk");

const client = new AevumClient({
  apiKey: "az_live_sk_your_api_key_here"
});

// List all entities
const entities = await client.entities.list({
  division: "energy",
  status: "active",
  limit: 20
});

entities.forEach(e => console.log(e.name));
package main

import (
    "fmt"
    "github.com/aevum-zenth/go-sdk"
)

func main() {
    client := zenth.NewClient("az_live_sk_your_api_key_here")
    entities, err := client.Entities.List(context.TODO())
    if err != nil {
        log.Fatal(err)
    }
    for, e := range entities {
        fmt.Println(e.Name)
    }
}

3. Parse the Response

                        
                    
{
  "data": [
    {
      "id": "ent_9xK2mP4qL7vR",
      "name": "Aevum Energy North America",
      "type": "subsidiary",
      "division": "energy",
      "status": "active",
      "location": {
        "city": "New York",
        "region": "Americas",
        "country": "US"
      },
      "created_at": "2024-01-15T08:30:00Z"
    }
  ],
  "pagination": {
    "total": 412,
    "page": 1,
    "per_page": 20,
    "next_cursor": "cursor_abc123"
  }
}

💡

Tip: The sandbox environment mirrors production data with test credentials. Use az_test_sk_ prefixed keys for development.

Authentication

All API requests require authentication. Aevum Zenth supports two authentication methods:

API Key Authentication

Include your API key in the Authorization header using Bearer token format:

Authorization: Bearer az_live_sk_your_api_key_here
Content-Type: application/json
X-Request-ID: req_unique_id_here # optional, for tracing

OAuth 2.0 (for third-party integrations)

For partner integrations requiring delegated access, use the OAuth 2.0 authorization code flow:

POST https://auth.aevumzenth.com/oauth/token

{
  "grant_type": "authorization_code",
  "code": "auth_code_from_callback",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "redirect_uri": "https://yourapp.com/callback"
}

⚠️

Security: Never expose API keys in client-side code. Use server-side proxying for browser-based applications. Keys starting with az_live_sk_ have full production access.

Scopes & Permissions

Scope	Description	Access Level
`entities:read`	Read entity and subsidiary data	Read
`entities:write`	Create and modify entities	Read/Write
`analytics:read`	Access analytics and metrics	Read
`operations:read`	View operational data	Read
`operations:write`	Manage operations and workflows	Read/Write
`admin:all`	Full administrative access	Admin

Rate Limits

API rate limits vary by plan and authentication method. Monitor your usage via the X-RateLimit-* response headers.

1,000

Requests / minute (Free)

10,000

Requests / minute (Pro)

100,000

Requests / minute (Enterprise)

Unlimited

Dedicated (Custom)

Rate Limit Headers

Header	Description
`X-RateLimit-Limit`	Maximum requests per window
`X-RateLimit-Remaining`	Remaining requests in current window
`X-RateLimit-Reset`	Unix timestamp when the window resets
`Retry-After`	Seconds to wait when rate limited (429 responses)

Error Handling

The API uses standard HTTP status codes and returns detailed error objects:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked.",
    "status": 401,
    "request_id": "req_xK9mP2qL7vR4",
    "documentation_url": "https://docs.aevumzenth.com/errors#invalid_api_key",
    "details": {
      "key_prefix": "az_live_sk_",
      "suggested_action": "Verify your API key in the developer dashboard"
    }
  }
}

Status Code	Error Code	Description
400	`invalid_request`	Malformed request or missing parameters
401	`invalid_api_key`	Missing, invalid, or revoked API key
403	`insufficient_scope`	API key lacks required permissions
404	`not_found`	Requested resource does not exist
429	`rate_limit_exceeded`	Too many requests. Check Retry-After header
500	`internal_error`	Unexpected server error. Contact support with request_id
503	`service_unavailable`	Temporary maintenance or outage. Check status page

Entities API

Manage and query organizational entities, subsidiaries, and departments across the Aevum Zenth conglomerate.

GET /v3/entities List all entities

Retrieve a paginated list of all organizational entities. Supports filtering by division, status, location, and type.

Query Parameters

Parameter	Type	Description
`division` optional	string	Filter by division (e.g., "energy", "tech", "aerospace")
`status` optional	string	Filter by status: "active", "inactive", "pending"
`type` optional	string	Filter by type: "subsidiary", "department", "joint_venture"
`region` optional	string	Filter by region: "americas", "emea", "apac"
`limit` optional	integer	Results per page (default: 20, max: 100)
`cursor` optional	string	Pagination cursor from previous response

Response

200 OK - Returns an array of entities with pagination metadata.

GET /v3/entities/{id} Retrieve an entity

Get detailed information about a specific entity by its unique identifier.

Path Parameters

Parameter	Type	Description
`id` required	string	The entity ID (e.g., "ent_9xK2mP4qL7vR")

200 OK - Entity details. 404 - Entity not found.

POST /v3/entities Create an entity

Create a new organizational entity within the Aevum Zenth structure.

Request Body

{
  "name": "Aevum Solar Division",
  "type": "subsidiary",
  "division": "energy",
  "parent_id": "ent_parent_id",
  "location": {
    "city": "Dubai",
    "country": "AE",
    "region": "Middle East"
  },
  "metadata": {
    "ein": "12-3456789",
    "founded": "2024-06-01"
  }
}

201 Created - New entity. 400 - Validation error.

PATCH /v3/entities/{id} Update an entity

Partially update an existing entity. Only provided fields will be modified.

200 OK - Updated entity. 404 - Entity not found.

DELETE /v3/entities/{id} Archive an entity

Soft-archive an entity. Archived entities remain queryable with include_archived=true.

200 OK - Entity archived. 403 - Insufficient permissions.

Analytics API

Access real-time and historical operational analytics across all Aevum Zenth divisions.

GET /v3/analytics/revenue Revenue metrics

Retrieve revenue data aggregated by division, region, or time period.

Query Parameters

Parameter	Type	Description
`period` optional	string	"daily", "weekly", "monthly", "quarterly", "yearly"
`division` optional	string	Filter by division
`start_date` optional	date	ISO 8601 date format
`end_date` optional	date	ISO 8601 date format

SDK Downloads

Official SDKs for all major programming languages with full type support, automatic retries, and comprehensive documentation.

🐍 Python ⚡ JavaScript 🔵 Go ☕ Java 💎 Ruby 🟣 C# 🦀 Rust 🏔️ Swift

Installation

pip install aevum-zenth
npm install @aevum-zenth/sdk
go get github.com/aevum-zenth/go-sdk/v3
gem install aevum-zenth

Webhooks

Subscribe to real-time events from the Aevum Zenth platform. Configure webhook endpoints from your developer dashboard.

{
  "id": "evt_2xK9mP4qL7vR8nB3",
  "type": "entity.updated",
  "timestamp": "2026-01-15T14:30:00Z",
  "data": {
    "object": "entity",
    "id": "ent_9xK2mP4qL7vR",
    "changes": {
      "status": {
        "from": "pending",
        "to": "active"
      }
    }
  },
  "signature": "sha256=a1b2c3d4e5f6..."
}

Event	Description
`entity.created`	A new entity was created
`entity.updated`	An entity was modified
`entity.archived`	An entity was archived
`operation.started`	A new operation began
`operation.completed`	An operation finished
`analytics.report_ready`	An analytics report is available
`webhook.failed`	Previous webhook delivery failed

GraphQL API Beta

For complex queries requiring flexible data selection, our GraphQL endpoint provides a powerful alternative to REST.

POST https://api.aevumzenth.com/graphql

query GetEntities($division: String, $limit: Int = 10) {
  entities(division: $division, limit: $limit) {
    id
    name
    status
    division
    location {
      city
      country
      coordinates {
        lat
        lng
      }
    }
    subsidiaries {
      id
      name
    }
  }
}

🧪

Beta Notice: The GraphQL API is currently in beta. Schema changes may occur. Use the X-API-Version: beta header to opt in.

Changelog

Track API changes, new features, and deprecations.

v3.2.1

January 10, 2026

Added energy division API endpoints with real-time grid monitoring data
Improved webhook delivery reliability with automatic retry logic
Fixed pagination cursor encoding for entities with special characters
Added X-Request-ID support for request tracing

v3.2.0

December 1, 2025

Introduced GraphQL API beta for flexible data queries
Added analytics endpoints for revenue and operational metrics
New OAuth 2.0 scopes for granular permission control
Rate limit headers now include Retry-After on 429 responses

v3.1.0

October 15, 2025

Added location and subsidiaries API endpoints
Introduced webhook signature verification
Python and Go SDK major version releases

Support

Need help with the Aevum Zenth API? We're here to assist.

📧

Email Support

Contact us at api-support@aevumzenth.com. We respond within 24 hours.

💬

Developer Community

Join our community forum for discussions, examples, and peer support.

📊

Status Page

Monitor API health and incident reports at status.aevumzenth.com.

📖

API Reference

Full auto-generated API reference available via OpenAPI 3.1 specification.