POST
/
interview

Authorizations

x-api-key
string
header
required

API key to access the API

Body

application/json

Request to create an interview

interview_name
string
required

Name of the interview

can_change_interview_language
boolean
default:
false

Whether the candidate can change the language

custom_questions
string[]

Additional questions for the interview (max 5)

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,
tr
is_coding_round_required
boolean
default:
false

​​Whether the coding round is required

is_proctoring_required
boolean
default:
true

Whether the proctoring is required

only_coding_round
boolean
default:
false

Whether the interview is a coding round only

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
skills
object[]

Required skills for the interview (max 5)

Response

200 - application/json

Response for creating an interview

data
object

Interview details

message
string

The message for the response

status
boolean

Whether the request was successful