Create Interview

Create Interview API

Create Interview

post

Create a new interview.

Authorizations

Body

interviewNamestringRequiredExample: Testing

roleNamestringOptionalExample: Software Engineer

minExperienceintegerOptionalExample: 3

maxExperienceintegerOptionalExample: 5

jdTypestring · enumRequiredExample: linkPossible values:

jdstringRequiredExample: https://some-jd-link.com

sampleQuestionsstring[]OptionalExample: ["Difference between Array and Tuple","Explain binary search"]

publishedbooleanOptionalExample: false

Responses

201

Interview created successfully

application/json

Responseall of

401

Missing or invalid Authorization header

application/json

422

Input Validation failed

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/interview/create HTTP/1.1
Host: interview-api.zeko.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 665

{
  "interviewName": "Testing",
  "roleName": "Software Engineer",
  "minExperience": 3,
  "maxExperience": 5,
  "jdType": "link",
  "jd": "https://some-jd-link.com",
  "sampleQuestions": [
    "Difference between Array and Tuple",
    "Explain binary search"
  ],
  "interviewConfig": {
    "redirectUrl": "https://example.com/callback",
    "allowAccess": "anyone",
    "allowLateAttempts": true,
    "allowContinueFromMiddle": true,
    "allowContinueFromMiddleCount": 1,
    "allowReattempt": false,
    "allowReattemptCount": 0,
    "allowInterviewOnMobile": false,
    "allowScreenLeaveCount": 2,
    "allowTabSwitchCount": 2,
    "webhookUrl": "https://example.com/webhook"
  },
  "metaData": {
    "Id": 12345,
    "name": "012 - Tester Interview",
    "clientId": 12434311
  },
  "published": false
}

{
  "message": "Interview created successfully",
  "success": true,
  "data": {
    "interviewId": "67fe36f746aab494be8f4956",
    "status": "draft",
    "interviewLink": "https://interview.zeko.ai/ai-interview/software-engineer8575574",
    "competencyData": [
      {
        "questionCount": 4,
        "time": 90,
        "competency": "B2B Demand Generation",
        "explanation": "As an interviewer, you...",
        "difficulty": "medium",
        "questionType": "scenario_based",
        "category": "vocal",
        "sampleQuestions": [
          "sample question 1"
        ]
      }
    ],
    "metaData": {
      "Id": 12345,
      "name": "012 - Tester Interview",
      "clientId": 12434311
    }
  }
}