Installation

Get started with Myxara in minutes using the official JavaScript/TypeScript SDK or REST API.

JavaScript/TypeScript SDK

npm

npm install @myxara/sdk-js

yarn

yarn add @myxara/sdk-js

bun

bun add @myxara/sdk-js

Requirements

• Node.js 18+ or Bun 1.0+
• TypeScript 5.0+ (optional but recommended)

Using the REST API

No installation needed! The REST API works with any HTTP client:

curl -X POST https://api.myxara.ai/v1/inboxes \
  -H "Authorization: Bearer mx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "support",
    "name": "Support Agent"
  }'

Get an API Key

1. Sign up at myxara.ai
2. Create an API key in the dashboard
3. Save the key - you won't be able to see it again!

Self-Hosting

Want to run Myxara on your own infrastructure?

Prerequisites

• Bun v1.0+ (or Node.js 20+)
• Supabase account (free tier works)
• AWS account with SES access

Quick Setup

# Clone the repository
git clone https://github.com/myxara/myxara.git
cd myxara

# Install dependencies
bun install

# Set up environment variables
cp .env.example .env
# Edit .env with your Supabase and AWS credentials

# Initialize the database
# Run migrations in your Supabase SQL editor

# Start the API server
cd api && bun dev

# Start the frontend
bun dev

For detailed self-hosting instructions, see the main README.

Verify Installation

Test that the SDK is working:

import { MyxaraClient } from '@myxara/sdk-js'

const client = new MyxaraClient({
  apiKey: 'mx_your_api_key'
})

// Test connection
const inboxes = await client.inboxes.list()
console.log(`Connected! You have ${inboxes.data.length} inboxes.`)

Next Steps

• Quick Start - Create your first inbox
• Authentication - Learn about API keys and scopes
• Examples - See complete code examples