Environment Setup

Configure your development environment for Mirra

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

Prerequisites

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

Installation

Install the SDK

The Mirra SDK allows you to interact with the Mirra platform programmatically.

npm install @mirra-messenger/sdk

Get your API Key

Generate an API key from the web portal or the mobile app (Settings → Developer).

Copy the key immediately. It's only shown once.

Store your API key securely. Never commit it to version control or expose it in client-side code.

Configure your Project

Create a .env file in your project root:

MIRRA_API_KEY=mirra_...

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 });
 
// List your resources to verify the connection
const resources = await mirra.resources.list();
console.log(`Connected! Found ${resources.length} resources.`);

Next Steps

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