HirePlus Docs

Analyze skills gaps

POST
/v1/skill-gaps

Analyse skill gaps for a completed CV analysis. Returns identified gaps, existing strengths, a personalised learning path, and a career readiness timeline.

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/skill-gaps" \  -H "Content-Type: application/json" \  -d '{    "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",    "target_role": "string",    "target_industry": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",
  "target_role": "string",
  "target_industry": "string",
  "overall_readiness": 100,
  "skill_gaps": [
    {
      "skill_name": "string",
      "category": "technical",
      "current_level": "none",
      "required_level": "none",
      "priority": "critical",
      "reasoning": "string",
      "estimated_learning_hours": 0
    }
  ],
  "existing_strengths": [
    {
      "skill_name": "string",
      "category": "technical",
      "level": "none",
      "market_demand": "high"
    }
  ],
  "learning_path": [
    {
      "order": 0,
      "skill_name": "string",
      "milestone": "string",
      "resources": [
        {
          "title": "string",
          "provider": "coursera",
          "url": "string",
          "type": "course",
          "duration": "string",
          "level": "beginner",
          "cost_range": "free",
          "relevance_score": 100
        }
      ],
      "estimated_weeks": 0
    }
  ],
  "estimated_time_to_ready": "string",
  "career_readiness_timeline": {
    "three_months": "string",
    "six_months": "string",
    "one_year": "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"
}

Analyze a CV POST

Submit a CV file for AI-powered analysis across up to 17 dimensions. Returns overall scores, actionable suggestions, keyword analysis, and market intelligence. Costs 1 credit per analysis (overage rates may apply).

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).