Getting Started

Installation


npm install @boooply/ai-interviews-sdk

Authentication

All API requests require an API key. You can get your API key from the Boooply dashboard or by contacting support.


# Store in your .env file
BOOOPLY_API_KEY=bply_org_xxxxxxxxxxxxx
BOOOPLY_BASE_URL=https://api.meetings.boooply.com

Security: Never expose your API key in client-side code. Always call the Boooply API from your backend.

Initialize the client


const { BoooplyClient } = require('@boooply/ai-interviews-sdk');
 
const client = new BoooplyClient({
  apiKey: process.env.BOOOPLY_API_KEY,
  baseUrl: process.env.BOOOPLY_BASE_URL,
  timeout: 30000, // optional, default 30s
});

Create your first interview


const interview = await client.interviews.create({
  type: 'ai',
  jobRole: 'Frontend Engineer',
  candidate: {
    name: 'Jane Doe',
    email: 'jane@example.com',
  },
  skills: ['React', 'TypeScript', 'CSS'],
  durationMinutes: 20,
});
 
console.log('Interview created:', interview.meetingCode);
console.log('Send this URL to the candidate:', interview.url);

The candidate opens the URL in their browser, and the AI interviewer takes over — asking questions, evaluating responses, and generating a detailed assessment.

Get results

After the interview completes, retrieve the evaluation:


const evaluation = await client.interviews.getEvaluation(interview.meetingCode);
 
console.log('Score:', evaluation.overallScore);       // 0-100
console.log('Recommendation:', evaluation.recommendation); // PASS | FAIL | REVIEW
console.log('Communication:', evaluation.communication);
console.log('Technical:', evaluation.technical);

Next steps

SDK Reference — Full API for creating and managing interviews
API Reference — REST API endpoints
Guides — Step-by-step tutorials
Webhooks — Real-time event notifications