> ## Documentation Index > Fetch the complete documentation index at: https://developer.jobmojito.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a new interview > Creates a new interview / coaching / assessment definition, generates its description, questions and candidate expectations via AI, and provisions default steps. Optionally provisions an embed key. ## OpenAPI ````yaml https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create openapi: 3.1.0 info: title: JobMojito API version: 1.0.0 description: >- Public API for JobMojito, served by Supabase Edge Functions. Authenticate with a Supabase JWT access token via the Authorization header. servers: - url: https://cool.jobmojito.com/functions/v1 description: Production security: [] tags: - name: Interviews description: >- Create, configure and manage interview / coaching / assessment definitions. - name: Results description: >- Interview results, transcripts, reports, re-attempt requests and analytics. - name: Candidates description: List and manage candidates. - name: Knowledge base description: Upload documents used to generate knowledge-base interviews. - name: Resume & Form verification description: Pre-screen candidates from resumes and forms. - name: Admin description: >- Account administration — invite team/coaching users, manage sub-merchants and avatar templates. paths: /job-interview-create: post: tags: - Interviews summary: Create a new interview description: >- Creates a new interview / coaching / assessment definition, generates its description, questions and candidate expectations via AI, and provisions default steps. Optionally provisions an embed key. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobInterviewCreateRequest' responses: '200': description: Interview created. content: application/json: schema: $ref: '#/components/schemas/JobInterviewCreateResponse' '401': description: Missing, expired or invalid access token. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- Validation error (missing required field, invalid enum value, out-of-range number, or unresolved template/language/knowledge-base id). content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- Server error (includes authorization failures and unhandled exceptions). content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: schemas: JobInterviewCreateRequest: type: object properties: name: type: string minLength: 1 description: Interview / position name. example: Project manager location: type: string minLength: 1 description: Job location. example: remote interview_template_id: type: string minLength: 1 format: uuid description: Id of the interview template to base this interview on. example: baa3bf7c-6926-46fd-9005-16738a31f72d mojito_language_code: type: string enum: - ar - bg - zh - hr - cs - da - nl - en - fil - fi - fr - de - el - hi - hu - id - it - ja - ko - ms - 'no' - pl - pt - br - ro - ru - sk - es - sv - ta - th - tr - uk - vi description: >- Platform language code used for the interview. Must be one of the platform-languages.json codes. example: en status: type: string enum: - draft - active description: >- Lifecycle status of the interview. Options — `draft`: Created but not published — not visible to candidates and cannot be run yet. Use to stage an interview before going live. | `active`: Published and live — candidates can run it.. example: active type: type: string enum: - interview - coaching - assessment description: >- Product type of the interview. Options — `interview`: Standard candidate interview for a role — answers are AI-scored and produce a hiring recommendation. | `coaching`: Practice/coaching session — candidate-facing feedback to help them improve; not a hiring evaluation. Only available on the coaching portal, NOT the interview portal. | `assessment`: Skills/knowledge assessment — evaluates competencies and is scored like an interview.. example: interview visibility: type: string enum: - merchant_public - merchant_invite - merchant_unlisted description: >- Who can discover and access the interview. Options — `merchant_public`: Listed on the merchant's public interview list — anyone with the merchant link can find and start it. | `merchant_invite`: Invite-only — only candidates explicitly invited (by email/link) can access it; not listed anywhere. | `merchant_unlisted`: Reachable only via a direct link — not listed anywhere; share the link manually.. example: merchant_public recording: type: string nullable: true enum: - audio_first_5_answers - audio_all - video_all - video_first_5_answers description: >- Cheating/proctoring detection mode for candidate answers — this is NOT a full session recording. Video options also record the candidate. Omit/null to disable. Options — `audio_first_5_answers`: Audio-only cheating detection, first 5 answers only. | `audio_all`: Audio-only cheating detection on every answer. | `video_all`: Audio + video cheating detection on every answer (candidate is recorded for all answers). | `video_first_5_answers`: Audio + video cheating detection, first 5 answers only.. example: video_all recording_full_session: type: string nullable: true enum: - audio_all - video_all description: >- Full interview-session recording (includes the avatar and voice) produced as a single file. Independent of `recording`. Omit/null to disable. Options — `audio_all`: Record the whole session audio (avatar + candidate voice) into a single file. Adds +0.2 credits. | `video_all`: Record the whole session video + audio (avatar + candidate) into a single file. Adds +0.4 credits.. example: video_all interview_type: type: string enum: - pre-screening - pre-screening-with-test-questions - second-interview - remote-freelancer-verification - strength-based-interview - potential-based-interview - process-verification-from-knowledge-base description: >- Interview style — configures the AI avatar and shapes both the AI-generated questions and the follow-up questions asked during the interview. Defaults to pre-screening when omitted. Options — `pre-screening`: Pre-screening — quick qualification check focusing on basic requirements and availability. | `pre-screening-with-test-questions`: Pre-screening with test questions — pre-screening plus practical questions to test relevant skills. | `second-interview`: Second round interview — deeper dive for candidates who passed initial screening. | `remote-freelancer-verification`: Remote worker verification — verify remote work capabilities and communication skills. | `strength-based-interview`: Strength-based interview — focus on what candidates enjoy and excel at to predict job satisfaction. | `potential-based-interview`: Potential-based interview — assess learning ability and growth potential rather than past experience. | `process-verification-from-knowledge-base`: Knowledge Base interview — generate questions from your knowledge base documents.. example: pre-screening-with-test-questions seniority_level: type: string nullable: true enum: - entry-level - intermediate - senior - managerial - director - executive description: >- Target seniority level for the role; auto-detected from the job description when omitted. Options — `entry-level`: Early-career or graduate roles. | `intermediate`: Some experience required. | `senior`: Experienced professional. | `managerial`: Team or department lead. | `director`: Director-level responsibility. | `executive`: C-suite or executive role.. example: senior result_view: type: string nullable: true enum: - none - minimal - minimal_with_score - advanced - full - full_expand_scores description: >- Result screen shown to the candidate after finishing. With any value other than `none`, the candidate sees a results screen where they can provide feedback, record an intro video and edit the transcript, and must then submit the result; the value sets how much score/result detail is shown. Options — `none`: No results screen at all — the interview is submitted immediately when the candidate finishes (no feedback, intro video, transcript edit or manual submit step). | `minimal`: Minimal results layout, no score shown. | `minimal_with_score`: Minimal results layout including the overall score. | `advanced`: Advanced results layout with more detail. | `full`: Full results layout with all sections. | `full_expand_scores`: Full results with every score breakdown expanded.. example: full candidate_video_introduction: type: string nullable: true enum: - optional - required description: Whether a candidate video introduction is optional or required. example: optional interview_tone: type: string nullable: true description: >- Interview tone — configures the AI avatar's speaking style and the tone of the AI-generated questions and follow-ups; omit to default to relaxed. Suggested values — `relaxed`: Friendly and conversational tone that helps candidates feel at ease. | `simple`: Plain language at CEFR A2 level — short sentences and simple words. | `professional`: Formal and business-like approach suitable for senior roles. | `persuasive`: Engaging style that encourages candidates to elaborate.. Case-insensitive; other strings are accepted but unknown tones fall back to the default. example: professional interview_length: anyOf: - type: number - type: string - nullable: true description: Number of questions to generate (max 40). example: 8 interview_attempts: type: number nullable: true minimum: 1 maximum: 20 description: Allowed candidate attempts (1-20). example: 1 max_duration: type: number nullable: true description: >- Maximum interview duration in minutes used to scope question generation. example: 30 code: type: string nullable: true description: Optional external code/reference for the interview. example: my code cover_image_url: type: string nullable: true description: Cover image URL. example: https://example.com/cover.png merchant_id: type: string nullable: true description: >- Merchant id. Only honored for admin or sub-merchant callers; otherwise taken from the JWT. example: 28106cba-1c27-4e53-b149-32113e5e8e31 knowledge_base_store_id: type: string nullable: true description: Knowledge base store id to source additional context from. description: type: string nullable: true description: Short job description (regenerated by AI). description_long: type: string nullable: true description: Long job description. candidate_expectations: type: string nullable: true description: Free-text candidate expectations folded into AI generation. welcome_message: type: string nullable: true description: Custom welcome message shown to the candidate. thank_you_message: type: string nullable: true description: Custom thank-you message shown after the interview. additional_context: type: object nullable: true additionalProperties: nullable: true description: Arbitrary additional context object merged into AI generation. instructional_video_custom_text: type: string nullable: true description: Custom narration text for the instructional video. is_embedded: type: boolean nullable: true description: >- Set true when the interview will be embedded as an iframe on an external page. Provisions an embed key and returns embed_id / embed_signing_key, which are used to authenticate/sign the iframe embed. example: false include_rapport_question: type: boolean nullable: true description: Include an opening rapport question. Defaults to false. example: true include_closing_prompt: type: boolean nullable: true description: Include a closing prompt. Defaults to true. example: true instructional_video: type: boolean nullable: true description: Show an instructional video before approval. Defaults to false. example: true use_enhanced_expectations: type: boolean nullable: true description: Reserved flag passed through to generation. custom_scoring: type: object nullable: true additionalProperties: nullable: true description: >- Custom result-scoring overrides merged with defaults and template overrides. required: - name - location - interview_template_id - mojito_language_code - status - type - visibility JobInterviewCreateResponse: type: object properties: interview_def_set_id: type: string description: Id of the newly created interview definition set. example: 00000000-0000-0000-0000-000000000000 embed_id: type: string description: Embed id, present only when is_embedded=true. embed_signing_key: type: string description: Embed signing key, present only when is_embedded=true. required: - interview_def_set_id description: >- Id of the created interview. Includes embed_id/embed_signing_key when is_embedded=true. Error: type: object properties: error: type: string example: Field is required. name: type: string example: interview_result_id required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Supabase JWT access token, passed as `Authorization: Bearer `.' ````