HirePlus Docs

Generate a CV

POST
/v1/generations

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

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/generations" \  -F region="US" \  -F template="executive"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pdf_url": "http://example.com",
  "docx_url": "http://example.com",
  "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 skills gaps POST

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

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.