Aevum Implementation Guide

Integrate the world's most comprehensive, AI-enhanced knowledge platform into your applications, research tools, and learning environments with our modern SDKs and REST API.

ℹ️ Platform Status All endpoints are production-ready. v2.4 introduces semantic search v3, real-time article sync, and improved multilingual routing.

Prerequisites

Before integrating Aevum into your stack, ensure you have:

Registered a developer account at developer.aevum.io
Generated an API Key with appropriate scopes (read:articles, read:graph)
Node.js 18+ / Python 3.10+ / or equivalent runtime environment
HTTPS configured for all production endpoints (TLS 1.2+ required)

Authentication

Aevum uses Bearer token authentication via API keys. All requests must include the Authorization header.

HTTP Request

GET /v2/articles/search?q=quantum+computing
Host: api.aevum.io
Authorization: Bearer ae_live_sk_8f7d6c5e4b3a2918...
Content-Type: application/json

⚠️ Security Notice Never expose live API keys in client-side code. Use proxy endpoints or environment variables for server-side integration. Test keys (ae_test_...) are rate-limited and cannot access premium datasets.

SDK Installation

Install the official Aevum SDK for your preferred language:

npm / yarn

# npm
npm install @aevum/enc-sdk

# yarn
yarn add @aevum/enc-sdk

pip

pip install aevum-sdk

Initialization

Configure the client with your API credentials and preferred region. The SDK automatically handles retries, timeouts, and serialization.

JavaScript (Node.js)

import { AevumClient } from '@aevum/enc-sdk';

const aevum = new AevumClient({
  apiKey: process.env.AEVUM_API_KEY,
  region: 'us-east-1',
  timeout: 8000,
  retries: 3,
  language: 'auto' // Detects from request headers
});

// Verify connection
const status = await aevum.health.check();
console.log(`Platform Status: ${status.status}`);

Search & Retrieve API

The core search endpoint supports semantic matching, facet filtering, and cross-lingual query resolution.

Parameter	Type	Description
`q` Required	string	Search query or natural language question
`lang` Optional	string	ISO 639-1 language code (defaults to request header)
`limit` Optional	integer	Results per page (max 100, default 20)
`expand` Optional	string[]	Include `graph`, `citations`, or `multimedia`

JavaScript

const results = await aevum.articles.search({
  q: 'explain dark matter in simple terms',
  lang: 'en',
  limit: 5,
  expand: ['graph', 'citations']
});

console.log(results.data[0].title);
// Output: "Dark Matter: Observational Evidence & Theoretical Models"

UI Components (Web)

For client-side integration, use our lightweight web components. They handle lazy loading, accessibility, and responsive rendering automatically.

HTML / Web Components


<script src="https://cdn.aevum.io/v2/ui/embed.min.js"></script>


<aevum-card 
  query="photosynthesis" 
  theme="dark" 
  lang="auto" 
  show-graph="true"
/>


<aevum-timeline 
  entity="industrial-revolution" 
  range="1760-1840"
/>

💡 Tip Web components automatically respect prefers-color-scheme and implement ARIA labels. Use the data-aevum-config attribute for advanced theming.

Real-time Sync & Webhooks

Subscribe to article updates, citation changes, and graph modifications via webhooks. Endpoints must respond with 200 OK within 3 seconds.

Webhook Payload Example

{
  "event": "article.updated",
  "timestamp": "2025-11-20T14:32:00Z",
  "data": {
    "article_id": "ae_art_9f8e7d6c5b",
    "changes": ["sections", "references"],
    "version": 42,
    "editor": "verified_expert_882"
  }
}