Quick Start Guide

Get up and running with the Coding Evaluation API in just a few minutes. Use our v1 API for third-party integration with API key authentication.

Get Your API Key

First, you'll need to register for an account and obtain your API key.

Registration

POST /api/auth/signup
Content-Type: application/json

{
  "email": "admin@yourcompany.com",
  "password": "SecurePassword123!",
  "companyName": "Your Company Inc",
  "fullName": "John Doe"
}

Login

POST /api/auth/login
Content-Type: application/json

{
  "email": "admin@yourcompany.com",
  "password": "SecurePassword123!"
}

// Response
{
  "success": true,
  "data": {
    "company": {
      "id": "comp_123",
      "name": "Your Company Inc",
      "apiKey": "sk_live_abcdef123456789"
    },
    "user": {
      "id": "user_456",
      "email": "admin@yourcompany.com",
      "fullName": "John Doe"
    }
  }
}

Make Your First Request

Let's create a simple coding question to test the API.

Create a Coding Question

1// JavaScript/Node.js
2const response = await fetch('https://evaluation.interviewscreener.com/api/questions', {
3  method: 'POST',
4  headers: {
5    'Authorization': 'Bearer YOUR_JWT_TOKEN',
6    'Content-Type': 'application/json'
7  },
8  body: JSON.stringify({
9    type: 'coding',
10    title: 'Two Sum',
11    description: 'Given an array of integers nums and an integer target, return indices of the two numbers such that they add up to target.',
12    difficulty: 'easy',
13    category: 'arrays',
14    topic: 'Hash Table',
15    marks: 20,
16    timeLimit: 300,
17    memoryLimit: 256,
18    boilerplateCode: {
19      javascript: 'function twoSum(nums, target) {\n    // Your code here\n}',
20      python: 'def two_sum(nums, target):\n    pass'
21    },
22    testCases: [
23      {
24        input: '[2,7,11,15], 9',
25        expectedOutput: '[0,1]',
26        isHidden: false
27      }
28    ]
29  })
30});
31 
32const question = await response.json();
33console.log(question);

Create and Launch a Test

Now let's create a test using the question we just created.

Create Test and Send Invitation Links

1// Create a test
2const testResponse = await fetch('https://evaluation.interviewscreener.com/api/tests', {
3  method: 'POST',
4  headers: {
5    'Authorization': 'Bearer YOUR_API_KEY',
6    'Content-Type': 'application/json'
7  },
8  body: JSON.stringify({
9    title: 'Frontend Developer Assessment',
10    description: 'Basic coding skills evaluation',
11    duration: 60, // minutes
12    questions: [
13      {
14        questionId: 'q_abc123', // Use the question ID from step 2
15        points: 20
16      }
17    ],
18    instructions: 'Read all questions carefully before starting.'
19  })
20});
21 
22const test = await testResponse.json();
23console.log('Test created:', test);
24 
25// Send test links to candidates
26const inviteResponse = await fetch('https://evaluation.interviewscreener.com/api/admin/send-test-link', {
27  method: 'POST',
28  headers: {
29    'Authorization': 'Bearer YOUR_API_KEY',
30    'Content-Type': 'application/json'
31  },
32  body: JSON.stringify({
33    testId: test.data.id,
34    candidates: ['jane.smith@example.com', 'john.doe@example.com'],
35    message: 'Please complete this assessment within 7 days.',
36    deadline: '2024-12-31T23:59:59Z'
37  })
38});
39 
40const invitation = await inviteResponse.json();
41console.log('Test links sent:', invitation);

🎉 You're All Set!

Congratulations! You've successfully created your first question, test, and invited a candidate. Here are some next steps to explore:

📖 API Documentation

Learn about all available endpoints and features

View Full Documentation →

🎮 API Playground

Test API endpoints interactively with real-time responses

Open API Playground →

📝 Questions API

Create and manage your coding questions library

Questions Documentation →

📊 Results API

Retrieve and analyze candidate assessment results

Results Documentation →