Create interview, using position data

This endpoint create new interview and generate interview sequence based on name, description, description_long and candidate expectations.

Endpoint needs name of the position at minimum.

Some or all fields below could be provided (that would make the interview questions more relevant) or if they are not provided, we will generate them using our LLM.

description

description_long

candidate_expectations

curl --location --request POST 'https://cool.jobmojito.com/functions/v1/job-interview-create' \ --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" }'

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

optional

Short description of position

description_long

string

optional

Long description of position (expected MD formating)

candidate_expectations

string

optional

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 interview attempts

>= 1<= 10

cover_image_url

string

optional

URL of the cover image

interview_template_id

string

required

Avatar ID from table interview_templates. To get ID, navigate to the Avatars, click to existing avatar and copy the ID.

knowledge_base_store_id

string

optional

ID of the knowledge base with additional context for the avatar. To get ID, navigate to the knowledge base, click Edit for existing directory and copy the ID.

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

interview_tone

enum<string>

required

Tone of the interview

Allowed values:

professionalrelaxed

questions_no

integer

optional

Number of questions to generate. If not provided, AI will automatically determine number of questions

>= 3<= 12

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

Examples

Create interview, using position data

Request

Responses