Installation

Magneteco is a fully-hosted memory service. You install our SDK and use your API key to connect—no infrastructure to deploy or manage.

Install the SDK

npm install @magneteco/client
# or
pnpm add @magneteco/client
# or
yarn add @magneteco/client

Get Your API Key

To use Magneteco, you need an App ID and API Key:

1. Sign up at magneteco.com/signup
2. Create an app in the dashboard
3. Copy your credentials (App ID and API Key)

Or contact us at hello@magneteco.io to get started.

Configure Environment Variables

Add these to your .env file:

# Magneteco Service
MAGNETECO_URL=https://api.magneteco.io/v1
MAGNETECO_API_KEY=your-api-key

That's it! No database URLs, no AWS credentials, no infrastructure setup.

Verify Installation

import { MagnetoClient } from '@magneteco/client';

const memory = new MagnetoClient({
  appId: 'your-app-id',
  baseUrl: process.env.MAGNETECO_URL,
  apiKey: process.env.MAGNETECO_API_KEY,
});

// Test connection
const health = await memory.health();
console.log(health);
// { status: 'healthy' }

Next Steps

• Quick Start - Start using Magneteco
• Domain Configuration - Configure for your domain
• Architecture - Understand the system design