HirePlus Docs

Get an interview preparation

GET
/v1/interview-preps/{id}

Retrieve a single interview preparation set by ID, including all generated questions, interview structure, and key areas to probe.

Authorization

ApiKeyAuth
x-api-key<token>

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

In: header

Path Parameters

id*string

Resource UUID

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://next.hireplus.ai/api/v1/interview-preps/123"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",
  "created_at": "string",
  "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"
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Invalid or expired API key"
}
{
  "error": "API key does not have required scope"
}
{
  "error": "string"
}
{
  "error": "Rate limit exceeded. Max 100 requests per minute."
}
{
  "error": "Internal server error"
}

Get a CV generation GET

Retrieve a single CV generation with full details including structured CV data and signed download URLs for PDF and DOCX files.

Get a skills gap analysis GET

Retrieve a single skills gap analysis by ID. Returns the full result including skill gaps, existing strengths, learning path, and career readiness timeline.