Create interview, using provided questions

This endpoint create new interview and create questions specified in the questions json object

curl --location --request POST 'https://cool.jobmojito.com/functions/v1/job-interview-create-from-array' \ --header 'Content-Type: application/json' \ --data-raw '{ "code": "my code", "name": "my position name", "description": "short interview description", "cover_image_url": "https://", "visibility": "merchant_public", "location": "my location", "type": "interview", "candidate_expectations": "my expectations", "interview_template_id": "681a489c-0f5d-4c19-8b1c-6ceadaad3793", "knowledge_base_store_id": "8267200c-3a48-49f3-9559-b0178ddb8a5c", "status": "active", "mojito_language_code": "sk", "interview_tone": "professional", "questions": [ { "id": "1234", "question": "Have you been in Paris?", "duration": 23, "is_conditional": true, "mojito_language_code": "en", "question_alternatives": [ "Have you been in London?", "Have you been in Brussels?" ] }, { "id": "5678", "question": "Tell me the capital city of that country?", "duration": 40, "conditional_question_main_id": "1234" } ] }'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

code

string

optional

External code of the interview (put your ID here)

name

string

required

Name of the position

description

string

required

Short description of position

description_long

string

optional

Long description of position (expected MD formating)

candidate_expectations

string

required

Instructions for AI describing ideal candidate

interview_type

enum<string>

required

Type of interview that would be generated

Allowed values:

pre-screeningpre-screening-with-test-questionssecond-interview

location

string

required

Provide location of the position, if it is remote, provide text "remote"

interview_attempts

integer

required

Maximum number of attempts

>= 1<= 10

cover_image_url

string

optional

URL of the cover image

interview_template_id

string

required

Avatar ID from table interview_templates

knowledge_base_store_id

string

optional

ID of the knowledge base with additional context for the avatar. ID is from table knowledge_base

status

enum<string>

required

When value 'active' is provided, generated interview is automatically published

Allowed values:

draftactive

visibility

enum<string>

required

Visibility of the interview

Allowed values:

merchant_publicmerchant_invitemerchant_unlisted

type

enum<string>

required

If the record is interview or coaching session

Allowed values:

interviewcoaching

mojito_language_code

string

required

Language code of the interview

recording

enum<string>

optional

Type of candidate recording. If field is not provided, recording is not enabled

Allowed values:

audio_first_5_answersaudio_allvideo_allvideo_first_5_answers

questions

array [object {7}]

required

string

required

External ID for referencing questions between themselves

question

string

required

Text of the question

duration

integer

optional

Expected duration in seconds

is_conditional

boolean

required

Is this main conditional question

mojito_language_code

string

optional

Language code of the question. Only provide if this question is in different language compared to main interview

question_alternatives

array[string]

optional

Array of alternative questions. System will choose at random, which question to ask

conditional_question_main_id

string

optional

ID of the main conditional question. Provide only if you want this question to be asked conditionally

Examples

Create interview, using provided questions

Request

Responses