Skip to main content
POST
Create a new interview (custom questions)

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 with only custom questions

interview_name
string
required

Name of the interview

Example:

"Candidate Screening Interview"

custom_question_list
object[]
required

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

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