HirePlus Docs

Generate interview questions

POST
/v1/interview-preps

Generate tailored interview questions based on a completed CV analysis. Returns categorised questions with difficulty levels, follow-ups, and a recommended interview structure.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication. Pass your key in the x-api-key request header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://next.hireplus.ai/api/v1/interview-preps" \  -H "Content-Type: application/json" \  -d '{    "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",
  "target_role": "string",
  "target_industry": "string",
  "total_questions": 0,
  "estimated_interview_minutes": 0,
  "questions": [
    {
      "question": "string",
      "category": "behavioral",
      "difficulty": "easy",
      "target_skill": "string",
      "why_asked": "string",
      "what_to_look_for": "string",
      "red_flag_answers": [
        "string"
      ],
      "follow_up_questions": [
        "string"
      ],
      "cv_reference": "string"
    }
  ],
  "interview_structure": {
    "opening": [
      "string"
    ],
    "core": [
      "string"
    ],
    "closing": [
      "string"
    ]
  },
  "key_areas_to_probe": [
    {
      "area": "string",
      "reason": "string",
      "suggested_approach": "string"
    }
  ],
  "candidate_summary": "string",
  "meta": {
    "credits": {
      "charged": 0,
      "balance": 0,
      "monthly_spend": 0,
      "monthly_cap": 0,
      "monthly_api_calls": 0,
      "is_overage": true
    }
  }
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Invalid or expired API key"
}
{
  "error": "string"
}
{
  "error": "API key does not have required scope"
}
{
  "error": "Resource not found"
}
{
  "error": "Rate limit exceeded. Max 100 requests per minute."
}
{
  "error": "Internal server error"
}

Generate a CV POST

Generate an AI-optimized CV from an uploaded file or a previous analysis. Supports multiple templates and regions. Returns signed URLs for PDF download (and DOCX for Business tier). Accepts JSON (with analysisId) or multipart/form-data (with file upload).

Get an analysis GET

Retrieve the full analysis with scores, detailed report data, and section breakdown. When status is "processing", result and sections are null.