API Documentation

The HirePlus API lets you programmatically analyze CVs and retrieve detailed scoring reports. All endpoints are available at https://hireplus.ai/api/v1.

Available Endpoints

For a complete list of all endpoints, request/response schemas, and code examples, see the API Reference.

Getting Started

1. Create an account on any plan (API access is included on all tiers)
2. Generate an API key from your Dashboard → API Keys
3. Include your API key in the x-api-key header with every request

Base URL: https://hireplus.ai/api/v1

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

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

Authentication

All API requests must include a valid API key in the x-api-key header. See Authentication for details.

Rate Limits

• 100 requests per minute per API key
• Monthly API call caps vary by plan:
  • Free: 50 calls/month
  • Starter: 1,000 calls/month
  • Professional: 5,000 calls/month
  • Business: 15,000 calls/month
• Calls beyond the monthly cap continue at overage rates (never hard-blocked)

See Rate Limits for details.