Skip to main content

Installation

Masar provides official SDKs for Python and TypeScript. Both wrap the same REST API, so you can pick whichever fits your stack. If you prefer raw HTTP, every endpoint is documented in the API Reference.

Python​

Requires Python 3.9 or later.

pip install masar-client

from masar import MasarClient

client = MasarClient(api_key="your-api-key")

# Quick check: embed a test input
embedding = client.embed({"name": "Test", "orbitals": []})
print(f"Connected. Embedding dimension: {len(embedding.vector)}")

TypeScript / Node.js​

Requires Node.js 18 or later.

npm install @almadar/masar-client

import { MasarClient } from '@almadar/masar-client';

const client = new MasarClient({ apiKey: 'your-api-key' });

// Quick check: embed a test input
const embedding = await client.embed({ name: 'Test', orbitals: [] });
console.log(`Connected. Embedding dimension: ${embedding.vector.length}`);

Verify Your Installation​

After installing, run the connection check shown above. If it prints the embedding dimension without errors, you're ready to go.

If you see an authentication error, check that your API key is correct. See Authentication for setup details.

Next Steps​