Interview
Create a new interview
Interview
Create a new interview
This endpoint creates a new interview, returns a unique interview ID and a corresponding interview URL. You can send this URL to candidates, add it to a job post or alternatively, use the invite candidate endpoint to send invitations for the interview.
POST
/
interview
Authorizations
x-api-key
string
headerrequiredAPI key to access the API
Body
application/json
interview_name
string
requiredName of the interview
skills
object[]
Required skills for the interview (max 5)
custom_questions
string[]
Additional questions for the interview (max 5)
interview_language
enum<string>
default: enThe language in which the AI interview will be conducted
Available options:
en, fr, de, he, hi, pt, es, tr can_change_interview_language
boolean
default: falseWhether the candidate can change the language
only_coding_round
boolean
default: falseWhether the interview is a coding round only
is_coding_round_required
boolean
default: falseWhether the coding round is required
selected_coding_language
enum<string>
default: user_choiceThe coding language for the coding round
Available options:
user_choice, javascript, cpp, c, csharp, go, java, kotlin, php, python, ruby, rust, swift is_proctoring_required
boolean
default: trueWhether the proctoring is required
Response
200 - application/json
status
boolean
Whether the request was successful
message
string
The message for the response
data
object
Interview details