client.createSession()

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
    { name: 'Rahul Verma',  email: 'rahul@example.com' },
  ],
  recruiterEmail: 'admin@yourcompany.com',
});

console.log(session.token); // → 'eyJhbGci...'

session = client.create_session(
    users=[
        {"name": "Priya Sharma", "email": "priya@example.com"},
        {"name": "Rahul Verma",  "email": "rahul@example.com"},
    ],
    recruiter_email="admin@yourcompany.com",
)

print(session["token"])  # → 'eyJhbGci...'

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
  ],
  recruiterId: '122344344533',
});

session = client.create_session(
    users=[{"name": "Priya Sharma", "email": "priya@example.com"}],
    recruiter_id="122344344533",
)

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
  ],
  recruiterId:    '122344344533',
  recruiterEmail: 'admin@yourcompany.com',
});

session = client.create_session(
    users=[{"name": "Priya Sharma", "email": "priya@example.com"}],
    recruiter_id="122344344533",
    recruiter_email="admin@yourcompany.com",
)

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uSWQiOiJzZXNzXzAxIn0.HMAC"
}

This is a Backend SDK method, not an HTTP endpoint. Call it from your server — never from the browser.

Install

npm install @recordorg/smartai-assessment-backend

pip install smartai-assessment-backend

Initialise

const AssessmentClient = require('@recordorg/smartai-assessment-backend');

const client = new AssessmentClient({
  apiKey:    process.env.ASSESSMENT_API_KEY,
  secretKey: process.env.ASSESSMENT_SECRET_KEY,
});

from smartai_assessment_backend import AssessmentClient
import os

client = AssessmentClient(
    api_key=os.getenv("ASSESSMENT_API_KEY"),
    secret_key=os.getenv("ASSESSMENT_SECRET_KEY"),
)

Signature

client.createSession({ users, recruiterId?, recruiterEmail? }): Promise<SessionToken>

client.create_session(
    *,
    users: list,
    recruiter_id: str = None,
    recruiter_email: str = None,
)

Parameters

array

required

Array of candidate objects. Must have at least one item.

Hide Each user object

string

required

Candidate’s full name. Shown in the assessment UI and result reports.

string

required

Candidate’s email address. Used as the unique identifier on the SmartAI platform. Match on this when you receive webhook results.

Example

[
  { "name": "Priya Sharma",  "email": "priya@example.com" },
  { "name": "Rahul Verma",   "email": "rahul@example.com" }
]

string

Your internal recruiter ID. You can pass this or recruiterEmail — at least one is required. You may pass both.

string

The recruiter’s email address. You can pass this or recruiterId — at least one is required. You may pass both.

Return value

string

A session token (JWT). Pass this directly to AssessmentPortal.open({ token }) in your frontend. Do not cache or store it — request a fresh one every time.

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
    { name: 'Rahul Verma',  email: 'rahul@example.com' },
  ],
  recruiterEmail: 'admin@yourcompany.com',
});

console.log(session.token); // → 'eyJhbGci...'

session = client.create_session(
    users=[
        {"name": "Priya Sharma", "email": "priya@example.com"},
        {"name": "Rahul Verma",  "email": "rahul@example.com"},
    ],
    recruiter_email="admin@yourcompany.com",
)

print(session["token"])  # → 'eyJhbGci...'

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
  ],
  recruiterId: '122344344533',
});

session = client.create_session(
    users=[{"name": "Priya Sharma", "email": "priya@example.com"}],
    recruiter_id="122344344533",
)

const session = await client.createSession({
  users: [
    { name: 'Priya Sharma', email: 'priya@example.com' },
  ],
  recruiterId:    '122344344533',
  recruiterEmail: 'admin@yourcompany.com',
});

session = client.create_session(
    users=[{"name": "Priya Sharma", "email": "priya@example.com"}],
    recruiter_id="122344344533",
    recruiter_email="admin@yourcompany.com",
)

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uSWQiOiJzZXNzXzAxIn0.HMAC"
}

Error cases

Condition	Error message
Neither `recruiterId` nor `recruiterEmail` provided	`Provide at least one of recruiterId or recruiterEmail` — pass one or both
`users` is an empty array / list	`users must be a non-empty array`
`name` missing in single mode	`name is required`
`email` missing in single mode	`email is required`
Invalid API key	HTTP 401 from SmartAI platform
`ASSESSMENT_API_KEY` not set	`Missing API key`

Getting Started

REST API

Backend SDK

Frontend SDK

Webhook & Data

Install

Initialise

Signature

Parameters

Return value

Error cases

​Install

​Initialise

​Signature

​Parameters

​Return value

​Error cases

Install

Initialise

Signature

Parameters

Return value

Error cases