Get an analysis
Retrieve the full analysis with scores, detailed report data, and section breakdown. When status is "processing", result and sections are null.
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
Analysis ID returned by POST /v1/analyses
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/analyses/123"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "processing",
"file_name": "string",
"target_role": "string",
"target_industry": "string",
"created_at": "string",
"completed_at": "string",
"scores": {
"overall": 0,
"ats": 0,
"keyword": 0,
"formatting": 0,
"impact": 0
},
"result": {
"suggestions": [
{
"title": "string",
"description": "string",
"severity": "critical",
"section": "string"
}
],
"keywords": {
"present": [
"string"
],
"missing": [
"string"
],
"recommended": [
"string"
],
"hard_skills": [
"string"
],
"soft_skills": [
"string"
],
"industry_terms": [
"string"
]
},
"ats_issues": [
{
"issue": "string",
"severity": "critical",
"fix": "string"
}
],
"formatting": {
"issues": [
"string"
],
"strengths": [
"string"
],
"length_assessment": "string"
},
"granular_scores": {
"overall_score": 0,
"ats_compatibility": 0,
"ats_parse_rate": 0,
"impact_score": 0,
"action_verb_strength": 0,
"quantification_level": 0,
"relevance_score": 0,
"hard_skills_coverage": 0,
"soft_skills_coverage": 0,
"keyword_density": 0,
"formatting_consistency": 0,
"readability_score": 0,
"length_optimization": 0,
"contact_completeness": 0,
"summary_effectiveness": 0,
"career_progression": 0,
"market_rarity_score": 0,
"ats_score": 0,
"keyword_score": 0,
"formatting_score": 0
},
"score_explanations": [
{
"score": 0,
"dimension": "string",
"explanation": "string",
"top_strength": "string",
"top_weakness": "string"
}
],
"bullet_rewrites": [
{
"original_text": "string",
"rewritten_text": "string",
"improvement_explanation": "string",
"issues": [
"string"
],
"section": "string"
}
],
"salary_intelligence": {
"estimated_range": {
"min": 0,
"max": 0,
"currency": "string",
"period": "year"
},
"primary_region": "string",
"experience_level": "entry",
"global_ranges": [
{
"country": "string",
"range": "string"
}
],
"salary_drivers": [
{
"factor": "string",
"impact": "high",
"explanation": "string"
}
]
},
"job_matches": [
{
"title": "string",
"fit_score": 0,
"matched_skills": [
"string"
],
"missing_skills": [
"string"
]
}
],
"key_strengths": [
"string"
],
"red_flags": [
{
"type": "employment_gap",
"severity": "critical",
"description": "string",
"mitigation": "string"
}
],
"quantification_audit": {
"total_bullets": 0,
"quantified_bullets": 0,
"quantification_rate": 0,
"unquantified_bullets": [
{
"original_text": "string",
"suggested_metrics": [
"string"
],
"rewrite_with_metrics": "string"
}
]
},
"generated_summaries": [
{
"text": "string",
"style": "achievement_focused",
"word_count": 0
}
],
"improvement_actions": [
{
"action": "string",
"category": "content",
"effort": "quick_win",
"time_estimate": "5_minutes",
"estimated_score_gain": 0
}
],
"contact_improvements": [
{
"area": "email",
"issue": "string",
"suggestion": "string",
"current_value": "string"
}
],
"projected_score": {
"min": 0,
"max": 0
},
"analysis_title": "string",
"analysis_description": "string"
},
"sections": [
{
"section_type": "summary",
"score": 100,
"suggestions": [
{
"title": "string",
"description": "string",
"severity": "critical",
"section": "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"
}Generate interview questions POST
Generate tailored interview questions based on a completed CV analysis. Returns categorised questions with difficulty levels, follow-ups, and a recommended interview structure.
Get analysis status GET
Check whether an analysis has completed processing. Useful for polling in asynchronous workflows. Returns the current status along with timestamps.