Quickstart Guide
Get up and running with the Aevum Encyclopedia API in under 5 minutes. Learn how to authenticate, make your first knowledge query, and embed insights into your application.
Before you begin, ensure you have an Aevum developer account and have generated an API key from your dashboard settings.
1. Install the SDK
We provide official SDKs for JavaScript, Python, and Go. For this guide, we'll use the JavaScript/TypeScript client.
npm install @aevum/encyclopedia-sdk2. Configure & Authenticate
Initialize the client with your API key. We recommend using environment variables for security.
import { AevumClient } from '@aevum/encyclopedia-sdk';
const aevum = new AevumClient({
apiKey: process.env.AEVUM_API_KEY,
environment: 'production' // or 'sandbox'
});
// Test connection
const health = await aevum.system.health();
console.log('API Status:', health.status);Use the sandbox environment for development. It isolates your requests, provides mock responses, and incurs zero quota usage.
3. Make Your First Query
The core endpoint /v1/knowledge/search accepts natural language queries and returns structured, verified knowledge graphs.
const response = await aevum.knowledge.search({
query: 'Explain quantum entanglement in simple terms',
depth: 'intermediate',
format: 'structured',
sources: true
});
console.log(response.summary);
console.log(response.related_topics);
console.log(response.citations);4. Embed the Knowledge Widget
For web applications, you can embed our interactive knowledge card directly into your UI. It automatically adapts to your theme and supports 140+ languages.
<!-- Load Aevum Widget SDK -->
<script src="https://cdn.aevum.io/widget/v2/aevum-widget.js" defer></script>
<!-- Widget Container -->
<div
id="aevum-knowledge-card"
data-query="machine learning fundamentals"
data-theme="dark"
data-lang="en"
></div>
<!-- Initialize -->
<script>
window.addEventListener('load', () => {
AevumWidget.init('your-public-key');
});
</script>The widget uses public keys only. Never expose your secret API key in client-side code. Public keys have built-in rate limits and domain restrictions.
Next Steps
You're now ready to integrate Aevum Encyclopedia into your project. Explore advanced features to build richer, more intelligent experiences.
Join our Developer Discord or email developers@aevum.io for personalized integration support.