Skip to main content
POST
Create a new interview

Authorizations

x-api-key
string
header
required

API key to access the API

Body

application/json

Request body to create an interview

Request to create an interview

interview_name
string
required

Name of the interview

Example:

"Full Stack Engineer Interview"

skills
object[]

Required skills for the interview (max 10)

Example:
custom_question_list
object[]

Custom questions for the interview (max 20)

Example:
interview_language
enum<string>
default:en

The language in which the AI interview will be conducted

Available options:
en,
fr,
de,
he,
hi,
pt,
es,
es-la,
tr,
ja,
sv,
ar,
pl,
dk,
kr,
it,
nl,
cz,
ua,
ur,
id,
en-GB,
es-MX,
cn,
zh-CN,
zh-TW,
zh-HK,
ru,
bn,
ms,
pt-BR,
vi,
tl,
th,
afb,
pt-PT
Example:

"en"

can_change_interview_language
boolean
default:false

Whether the candidate can change the language

only_coding_round
boolean
default:false

Whether the interview is a coding round only

is_coding_round_required
boolean
default:false

​​Whether the coding round is required

selected_coding_language
enum<string>
default:user_choice

The coding language for the coding round

Available options:
user_choice,
javascript,
cpp,
c,
csharp,
go,
java,
kotlin,
php,
python,
ruby,
rust,
swift,
typescript
Example:

"python"

coding_exercise_details
string

Add more details to tailor the coding exercise (optional) - Note: The candidate won't be able to use outside libraries.

Example:

"Make the DSA problem extremely difficult and focus on a problem that will require recursion to solve efficiently."

is_proctoring_required
boolean
default:true

Whether the proctoring is required

Response

Successful response

Response for creating an interview

status
boolean

Whether the request was successful

Example:

true

message
string

The message for the response

Example:

"Interview created successfully"

data
object

Interview details