Skip to main content

TypeScript SDK Installation

The TypeScript/JavaScript SDK for the Mentiora platform.

Installation

Install the package using npm:

npm install @mentiora/sdk

Or with yarn:

yarn add @mentiora/sdk

Or with pnpm:

pnpm add @mentiora/sdk

Requirements

  • Node.js >= 18.0.0
  • TypeScript >= 5.0 (optional, for TypeScript projects)

Import

ES Modules

import { MentioraClient } from '@mentiora/sdk';

CommonJS

const { MentioraClient } = require('@mentiora/sdk');

Create a Client

import { MentioraClient } from '@mentiora/sdk';

const client = new MentioraClient({
apiKey: process.env.MENTIORA_API_KEY,
environment: 'production', // or 'staging'
});

Configuration Options

OptionTypeRequiredDescription
apiKeystringYesProject API key (from Mentiora platform)
environment'staging' | 'production'YesTarget environment
projectIdstringNoProject UUID (optional)
baseUrlstringNoOverride base URL (for testing)
timeoutnumberNoRequest timeout in ms (default: 30000)
retriesnumberNoMax retry attempts (default: 3)

Next Steps