API Reference
Start typing to search…

Overview

This section involves a high level explanation of how the API endpoints are connected and will affect the AI interview process. You can use this as a resource to view how our schema works.

%%{init: {
  'flowchart': {
    'nodeSpacing': 150,
    'rankSpacing': 150
  }
}}%%
flowchart LR
  Organization["Organization"]
  Job["Job"]
  Candidate["Candidate"]
  Script["Script"]
  ScriptTask["Script Task"]
  Call["Call"]

  Organization -- "one to many" --> Job
  Job      -- "one to many" --> Candidate
  Job      -- "many to many" --> Script
  Script   -- "one to many" --> ScriptTask
  Candidate-- "one to many" --> Call

Jobs

Each account on Classet can have as many jobs as possible. You can easily create these through our jobs endpoints here. You can include all basic information about a job such as title, description, wage, location, etc.

For each job, you can also include information that will more directly affect the AI interviews such as:

  • script_id - The script that will be used in the phone interview for all candidates applying for this job
  • faqs - Any answers to questions that the candidate may ask during the interview. This field will be referenced during the interview if candidates ask questions that the job description does not already answer.
  • application_questions - These are questions that are asked in within your job application page. We recommend ONLY including really short or binary yes/no questions because during the phone interview, these questions will be reconfirmed with the candidate. Long question formats will degrade the interview flow with the candidate

Scripts

A script on Classet is an interview template with its own unique script_id. A script can be attached to as many jobs as possible. And you can create as many scripts as you need. A script is made of multiple script tasks, each with their own objective for the interview. We have 4 default tasks to choose from, and each has its own tasks:

  • Standard Interview
  • Basic Interview
  • Resume Generating Interview
  • Disqualifying Interview

Standard Interview

  1. Introduction - When the call starts and the agent greets the candidate
  2. AI Introduction - When the agent introduces themselves and the purpose of the call to the candidate
  3. Sell The Position - When the agent gives a brief summary and describes the job
  4. Learn the Basics about the Candidate - The agent asks basic background questions that you define (removable)
  5. Examine the Candidate’s Experience - When the agent begins to ask the candidate about their recent and/or past work experience (removable)
  6. Reconfirm Application Answers - When the agent begins to confirm questions and answers or details from the application with the candidate (removable)
  7. Establish Next Steps - When the agent asks for information for a follow up call such as when they would be able to start, or best time to reach them for a follow-up

Basic Interview

  1. Introduction - When the call starts and the agent greets the candidate
  2. AI Introduction - When the agent introduces themselves and the purpose of the call to the candidate
  3. Sell The Position - When the agent gives a brief summary and describes the job
  4. Learn the Basics about the Candidate - The agent asks basic background questions that you define (removable)
  5. Establish Next Steps - When the agent asks for information for a follow up call such as when they would be able to start, or best time to reach them for a follow-up

Resume Generating Interview

  1. Introduction - When the call starts and the agent greets the candidate
  2. AI Introduction - When the agent introduces themselves and the purpose of the call to the candidate
  3. Sell The Position - When the agent gives a brief summary and describes the job
  4. Learn the Basics about the Candidate - The agent asks basic background questions that you define (removable)
  5. Experience and Unemployment Gaps - When the agent begins to ask the candidate about their recent and/or past work experience and also digs into the gaps when they were not employed (removable)
  6. Reconfirm Application Answers - When the agent begins to confirm questions and answers or details from the application with the candidate (removable)
  7. Establish Next Steps - When the agent asks for information for a follow up call such as when they would be able to start, or best time to reach them for a follow-up (removable)

Disqualifying Interview

  1. Introduction - When the call starts and the agent greets the candidate
  2. AI Introduction - When the agent introduces themselves and the purpose of the call to the candidate
  3. Sell The Position - When the agent gives a brief summary and describes the job
  4. Qualify the Candidate - When the agent asks the candidate about the job requirements, and use the answers to qualify or disqualify the candidate (removable)
  5. Learn the Basics about the Candidate - The agent asks basic background questions that you define (removable)
  6. Experience and Unemployment Gaps - When the agent begins to ask the candidate about their recent and/or past work experience and also digs into the gaps when they were not employed (removable)
  7. Establish Next Steps - When the agent asks for information for a follow up call such as when they would be able to start, or best time to reach them for a follow-up

Script Task

A script task accomplishes one thing in the interview, whether it is to greet the candidate or dive into their work experience. Some tasks have the option of including questions to ask, and others do not. We have a default number of questions for each task that will be asked during the interview, but you can always update or include your own. You can also remove with the field removed for each task, and they will not be discussed during the interview.

Candidates

Each candidate will be associated with a single job through the job_id. Ideally, candidates should have a valid phone number for the field phone so the interview can take place on the phone. But if not, there is a unique web call url that is generated for that candidate, and is returned where the interview can still be conducted.

  • answers - This field is directly associated with application_questions field within jobs. This is where you can include the answers of the candidate to those application_questions. We will string match these questions, so make sure the question is identical to the ones in application_questions

Calls

Calls are all the interview sessions that occurred with a candidate. A candidate can have multiple interview sessions. And each successive interview session will begin from where the candidate left off from the previous one, in the case that they hang up. When you register a call, a candidate will be created automatically with the phone as the unique identifier if they do not already exist