Environment Setup

This guide covers the tools you need to start building on Mirra.

Prerequisites

Node.js: Version 18 or higher.
Mirra Account: Sign up here.
Code Editor: VS Code is recommended.

Installation

Install the SDK

The Mirra SDK allows you to manage resources and scripts programmatically.

npm install @mirra-messenger/sdk

Get your API Key

Log in to the Mirra Developer Portal.
Go to Settings > API Keys.
Create a new key (sk_live_...).

Keep your API key secure. Do not commit it to version control.

Configure your Project

Create a .env file in your project root:

MIRRA_API_KEY=sk_live_...

Verify Installation

Create a simple script to test your connection:

import { MirraSDK } from '@mirra-messenger/sdk';
 
const mirra = new MirraSDK({ apiKey: process.env.MIRRA_API_KEY });
 
async function check() {
  const user = await mirra.auth.me();
  console.log(`Authenticated as: ${user.email}`);
}
 
check();

Next Steps

Now that your environment is ready, create your first agent.