Documentation
Everything you need to integrate and use NeurometriX.
Getting Started
Get up and running with NeurometriX in four simple steps.
1
Install the SDK
npm install @neurometrix/sdk
2
Authenticate
import { NeurometriX } from '@neurometrix/sdk';
const client = new NeurometriX({
apiKey: process.env.NEUROMETRIX_API_KEY,
});3
Create an Assessment
const session = await client.assessments.create({
jobId: 'job_abc123',
candidateEmail: 'jane@example.com',
games: ['memory-matrix', 'logic-chains', 'pattern-spotter'],
});
console.log(session.inviteUrl);
// https://assess.neurometrix.io/s/sess_xyz7894
Get Results
const scores = await client.assessments.getScores(session.id);
// scores.traits → array of 91 trait scores
// scores.overallMatch → 0-100 match percentage
// scores.report → { pdfUrl, narrative }