Skip to main content

Getting Started

Welcome to the Enhancv API! This guide will help you get started with integrating Enhancv's resume management capabilities into your application.

Overview​

The Enhancv API allows you to programmatically:

  • List resumes - Retrieve all resumes in your account with pagination
  • Download resumes - Export resumes as PDF or plain text files
  • Upload resumes - Parse and import resumes from various formats

Prerequisites​

To use the Enhancv API, you need:

  1. An Enhancv Business Plan - API access is only available for business plan users
  2. An API Key - Generated from your account settings

Base URL​

All API requests should be made to:

https://api.enhancv.com/api/v1

Quick Start​

1. Get Your API Key​

  1. Log in to your Enhancv account at app.enhancv.com
  2. Navigate to Account Settings → Profile
  3. Scroll to the API Keys section
  4. Click Generate New API Key
  5. Copy and save your API key - it will only be shown once!
Keep Your API Key Secure

Treat your API key like a password. Never commit it to version control or share it publicly. If your key is compromised, delete it immediately and generate a new one.

2. Make Your First Request​

Here's a simple example to list your resumes:

Example: List Resumes
curl https://api.enhancv.com/api/v1/resumes \
  -H "Authorization: Bearer enh_live_your_api_key_here"
Response
{
  "resumes": [
    {
      "id": "64f1a2b3c4d5e6f7g8h9i0j1",
      "title": "Software Engineer Resume",
      "filename": "JohnDoeResume.pdf",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "isCoverLetter": false
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  }
}

Next Steps​

Support​

Need help? Contact us at support@enhancv.com