Implementation Guide

Integrate Aevum Encyclopedia's AI-powered knowledge engine into your application in under 10 minutes.

This guide walks developers through the complete integration process for Aevum's Knowledge API & Embed SDK. Whether you're building an educational platform, research tool, or enterprise knowledge base, our SDK provides seamless access to verified, multilingual encyclopedia data with semantic search and interactive knowledge graphs.

ℹ️

Requires a free Aevum Developer account. Commercial usage beyond 50K requests/month requires a Pro license.

Prerequisites

  • Node.js 16+ or modern browser (ES2020 compatible)
  • Active Aevum Developer Account
  • Project ID from Dashboard
  • HTTPS endpoint for production (recommended)

1. Generate API Key

1

Access Developer Console

Navigate to dashboard.aevum.dev/project/{your-id}/keys. Click Generate New Key, assign a descriptive name, and restrict permissions to read:articles and read:graphs.

⚠️

Never expose your secret key in client-side code. Use environment variables or a backend proxy for production deployments.

2. Install SDK

Install the official JavaScript/TypeScript package via your preferred package manager:

Terminal
npm install @aevum/encyclopedia-sdk

Or import directly in browser environments:

HTML
<script src="https://cdn.aevum.dev/sdk/v2/aevum-sdk.min.js"></script>

3. Embed Widget

Initialize the SDK and render the interactive knowledge widget:

JavaScript
import { AevumWidget } from '@aevum/encyclopedia-sdk';

const widget = new AevumWidget({
  apiKey: process.env.AEVUM_API_KEY,
  projectId: 'proj_x9k2m4',
  container: '#aevum-embed',
  theme: 'dark',
  locale: 'en-US'
});

widget.render();

Add the target container to your HTML:

HTML
<div id="aevum-embed" style="min-height: 400px;"></div>

4. Configure & Customize

Customize behavior, appearance, and data scope using the configuration object:

Parameter Type Default Description
theme string 'auto' UI theme: 'light', 'dark', or 'auto'
locale string 'en-US' Primary language for search & UI text
maxDepth number 2 Knowledge graph traversal depth
autoSync boolean true Pull live updates when new articles are published
filters object {} Restrict to categories: { categories: ['science', 'history'] }

Testing & Verification

Use the built-in verification mode to validate integration before production deployment:

JavaScript
await widget.verify({
  simulateSearch: true,
  checkGraphConnectivity: true,
  timeout: 5000
});

// Returns: { status: 'ok', latency: 142ms, articlesIndexed: 2418903 }
🔍

Monitor request usage and latency in real-time at dashboard.aevum.dev/analytics.

Support & Next Steps

Need help? Visit our developer community or open a ticket:

  • API Reference: docs.aevum.dev/api
  • Community Discord: discord.gg/aevum-dev
  • Email Support: dev-support@aevum.dev

Once verified, deploy your integration and watch real-time metrics track user engagement with Aevum's knowledge network.