Quick Start
Get up and running with Auva in under 5 minutes. This guide walks you through environment setup, authentication, and your first API call.
Prerequisites
Before you begin, make sure you have:
- Node.js 18+ installed (download)
- An Auva Account: create one here
- A terminal and your favorite code editor
Installation
Install the Auva SDK in your project:
npm install @auva/sdk
Step-by-Step Setup
Create an Auva Account
Head to auva.dev/register and create your account. You'll get immediate access to all Auva services with a single set of credentials.
Your account includes:
- A unique username (
@yourname) - API access tokens
- Access to all ecosystem products
Get Your API Key
Navigate to your Account Settings → Developer → API Keys. Generate a new key and store it securely.
# Store it in your environment
export AUVA_API_KEY="your-api-key-here"
Never commit your API key to version control. Use environment variables or a secrets manager.
Initialize the Client
Create a new file and configure the Auva SDK:
import { AuvaClient } from '@auva/sdk';
const auva = new AuvaClient({
apiKey: process.env.AUVA_API_KEY,
baseUrl: 'https://auth.auva.dev',
});
Make Your First Request
Verify everything works by fetching your profile:
async function main() {
const me = await auva.auth.me();
console.log(`Welcome, ${me.name}! (@${me.username})`);
console.log(`Email: ${me.email}`);
console.log(`Account created: ${me.createdAt}`);
}
main();
If you see your name in the console: you're connected to the Auva ecosystem.
What's Next?
Now that you're set up, explore what you can build: