v2.0 Public Beta

API Reference

Integrate our advanced AI recruitment engine directly into your ATS or internal tools. Our REST API allows you to programmatically analyze resumes, process interviews, and generate tailored questions.

Base URL

https://recruitai-api-gateway.keertikaonline.com/api

Authentication

All API requests must include your API Key in the X-API-Key header. You can find your API key in your account dashboard.

Header Format

X-API-Key: sk_live_51M...
POST/proxy/upload/resume

Resume Analysis

Upload a candidate's resume (PDF/DOCX) along with the Job Description (JD) to get a comprehensive compatibility analysis.

Parameters

resumeFile

The candidate Resume file (PDF, DOCX)

Required
jd_fileFile

The Job Description file

Required

Example Request

const form = new FormData();
form.append('resume', resumeFile);
form.append('jd_file', jdFile);

const response = await fetch('https://api.recruitment-ai.com/api/proxy/upload/resume', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: form
});
POST/proxy/upload/interview

Interview Analysis

Submit an audio recording of an interview to receive a full transcript and behavioral analysis report.

Parameters

resumeFile

The candidate Resume

Required
audioFile

Interview audio recording (MP3, WAV)

Required
jd_fileFile

The Job Description

Required

Example Request

const form = new FormData();
form.append('audio', audioFile);
form.append('resume', resumeFile);
form.append('jd_file', jdFile);

const response = await fetch('https://api.recruitment-ai.com/api/proxy/upload/interview', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: form
});
POST/proxy/generate/questions

Generate Questions

Generate a list of tailored interview questions based on the specific requirements in a Job Description.

Parameters

jd_fileFile

The Job Description file to analyze

Required

Example Request

const form = new FormData();
form.append('jd_file', jdFile);

const response = await fetch('https://api.recruitment-ai.com/api/proxy/generate/questions', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: form
});
GET/proxy/logs

Retrieve Logs

Get a paginated list of all your past API requests and their processing status.

Parameters

pageQuery

Page number for pagination

limitQuery

Number of items per page

Example Request

const response = await fetch('https://api.recruitment-ai.com/api/proxy/logs?page=1&limit=10', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});