HirePlus Docs

Analyze a CV

POST
/v1/analyses

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

Authorization

ApiKeyAuth
x-api-key<token>

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

In: header

Request Body

multipart/form-data

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/analyses" \  -F file="string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "completed",
  "scores": {
    "overall": 100,
    "ats": 100,
    "keyword": 100,
    "formatting": 100,
    "impact": 100
  },
  "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"
}