Skip to main content
POST
/
custom
/
interview
Create a new interview (custom questions)
curl --request POST \
  --url https://public.api.micro1.ai/custom/interview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "interview_name": "Candidate Screening Interview",
  "custom_question_list": [
    {
      "question": "What are your strengths and weaknesses?",
      "time": 2,
      "type": "audio"
    }
  ],
  "interview_language": "en",
  "can_change_interview_language": false,
  "is_proctoring_required": true
}'
{
  "status": true,
  "message": "Interview created successfully",
  "data": {
    "interview_id": "123e4567-e89b-12d3-a456-426614174000",
    "invite_url": "https://interview.micro1.ai/intro/micro1?uid=123e4567-e89b-12d3-a456-426614174000"
  }
}

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:
[
  {
    "question": "What are your strengths and weaknesses?",
    "time": 2,
    "type": "audio"
  }
]
​
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,
es-la,
ja,
sv,
ar
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