API Quickstart

This guide gets you from zero to your first API-powered CV analysis in under 5 minutes.

Prerequisites

A NeoCV account on the Business plan
An API key (create one in Dashboard → Settings → API Keys)
A CV file (PDF, DOCX, or TXT)

Step 1: Set Up Your API Key

export HIREPLUS_API_KEY="hp_your_key_here"
export HIREPLUS_BASE_URL="https://$(HIREPLUS_DOMAIN)/api/v1"

Step 2: Submit a CV for Analysis

curl -X POST $HIREPLUS_BASE_URL/analyze \
  -H "x-api-key: $HIREPLUS_API_KEY" \
  -F "file=@resume.pdf" \
  -F "target_role=Software Engineer"

Response:

{
  "id": "a1b2c3d4-...",
  "status": "completed",
  "scores": {
    "overall": 78,
    "ats": 85,
    "keyword": 72,
    "formatting": 90,
    "impact": 65
  }
}

Step 3: Get the Full Report

curl $HIREPLUS_BASE_URL/reports/$ANALYSIS_ID \
  -H "x-api-key: $HIREPLUS_API_KEY"

Step 4: Check Your Usage

curl $HIREPLUS_BASE_URL/usage \
  -H "x-api-key: $HIREPLUS_API_KEY"

Node.js Example

import fs from 'fs';

const HIREPLUS_API_KEY = process.env.HIREPLUS_API_KEY!;
const BASE_URL = `https://${process.env.NEXT_PUBLIC_BRAND_DOMAIN}/api/v1`;

async function analyzeCV(filePath: string, targetRole?: string) {
  const formData = new FormData();
  const file = new Blob([fs.readFileSync(filePath)]);
  formData.append('file', file, 'resume.pdf');

  if (targetRole) {
    formData.append('target_role', targetRole);
  }

  // 1. Submit for analysis
  const analyzeRes = await fetch(`${BASE_URL}/analyses`, {
    method: 'POST',
    headers: { 'x-api-key': HIREPLUS_API_KEY },
    body: formData,
  });
  const { id, scores } = await analyzeRes.json();
  console.log('Overall score:', scores.overall);

  // 2. Get full report
  const reportRes = await fetch(`${BASE_URL}/analyses/${id}`, {
    headers: { 'x-api-key': HIREPLUS_API_KEY },
  });
  const report = await reportRes.json();

  return report;
}

// Usage
const report = await analyzeCV('./resume.pdf', 'Senior Software Engineer');
console.log('Suggestions:', report.result.suggestions);

Python Example

import requests

import os

API_KEY = os.environ["HIREPLUS_API_KEY"]
BASE_URL = os.environ["HIREPLUS_BASE_URL"]  # https://<BrandDomain>/api/v1

headers = {"x-api-key": API_KEY}

# Submit CV
with open("resume.pdf", "rb") as f:
    response = requests.post(
        f"{BASE_URL}/analyses",
        headers=headers,
        files={"file": f},
        data={"target_role": "Software Engineer"},
    )

result = response.json()
print(f"Overall score: {result['scores']['overall']}")

# Get full report
report = requests.get(
    f"{BASE_URL}/analyses/{result['id']}",
    headers=headers,
).json()

Next Steps

Full API Reference — All endpoints and parameters
Rate Limits — Understand usage limits
Error Reference — Troubleshoot common issues

API Quickstart

On this page