HirePlus Docs

Get a skills gap analysis

GET
/v1/skill-gaps/{id}

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

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/skill-gaps/123"
{
  "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"
  },
  "created_at": "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 an interview preparation GET

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

Get usage statistics GET

Retrieve API usage statistics including daily breakdown for the last 7 days, credit balance, monthly spend, and remaining call estimates.