API Reference

curl -X POST https://cvparserpro.com/api/v1/parse \
  -H "X-API-Key: ts_your_api_key" \
  -F "[email protected]"

curl https://cvparserpro.com/api/v1/candidates/{candidate_id} \
  -H "X-API-Key: ts_your_api_key"

# Poll until parsing_status = "completed"

{
  "data": {
    "id": "8b212bcd-a0d0-4a08-bc29-ba932b713ec1",
    "full_name": "John Smith",
    "email": "[email protected]",
    "current_title": "Senior Software Engineer",
    "years_of_experience": 8,
    "skills": ["Python", "JavaScript", "React", "AWS"],
    "work_history": [...],
    "education": [...],
    "parsing_status": "completed",
    "parsing_confidence": 0.92
  }
}

curl -X POST https://cvparserpro.com/api/v1/parse \
  -H "X-API-Key: ts_your_api_key" \
  -F "[email protected]" \
  -F "[email protected]"

{
  "success": true,
  "candidates": [
    {
      "id": "8b212bcd-a0d0-4a08-bc29-ba932b713ec1",
      "filename": "resume1.pdf",
      "status": "pending"
    }
  ],
  "credits_remaining": 495
}

curl -X POST https://cvparserpro.com/api/v1/parse/url \
  -H "X-API-Key: ts_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/resume.pdf"
    ]
  }'

{
  "success": true,
  "processed": 1,
  "failed": 0,
  "candidates": [
    {
      "id": "8b212bcd-a0d0-4a08-bc29-ba932b713ec1",
      "filename": "resume.pdf",
      "status": "pending"
    }
  ],
  "errors": [],
  "credits_remaining": 495
}

{
  "id": "8b212bcd-a0d0-4a08-bc29-ba932b713ec1",
  "full_name": "Sarah Chen",
  "email": "[email protected]",
  "phone": "+1 415-555-0123",
  "location": "San Francisco, CA",
  "current_title": "Senior Software Engineer",
  "years_of_experience": 7,
  "skills": ["Python", "JavaScript", "React", "AWS", "PostgreSQL"],
  "languages": ["English", "Mandarin"],
  "work_history": [
    {
      "company": "TechCorp Inc",
      "title": "Senior Software Engineer",
      "start_date": "2021-03",
      "end_date": "present",
      "is_current": true,
      "description": "Led backend development for payment systems..."
    }
  ],
  "education": [
    {
      "institution": "Stanford University",
      "degree": "Bachelor of Science",
      "field": "Computer Science",
      "start_year": "2013",
      "end_year": "2017"
    }
  ],
  "certifications": [
    {
      "name": "AWS Solutions Architect",
      "issuer": "Amazon Web Services",
      "date": "2022"
    }
  ],
  "linkedin_url": "https://linkedin.com/in/sarahchen",
  "github_url": "https://github.com/sarahchen",
  "portfolio_url": "https://sarahchen.dev",
  "ai_summary": "Sarah is a software engineer with 7+ years of experience...",
  "original_filename": "sarah_chen_resume.pdf",
  "source": "api",
  "parsing_status": "completed",
  "parsing_confidence": 0.94,
  "parsing_errors": null,
  "tags": [
    { "id": "tag-uuid", "name": "Senior Level", "color": "#D97706" }
  ],
  "jobs": [
    {
      "job_id": "job-uuid",
      "job_title": "Lead Engineer",
      "match_score": 92,
      "status": "screening",
      "score_breakdown": { "skills": 95, "experience": 90, "education": 85 }
    }
  ],
  "created_at": "2026-01-28T01:39:09.804Z",
  "parsed_at": "2026-01-28T01:39:35.102Z"
}

curl "https://cvparserpro.com/api/v1/candidates?page=1&limit=10&status=completed" \
  -H "X-API-Key: ts_your_api_key"

curl -X PATCH https://cvparserpro.com/api/v1/candidates/{id} \
  -H "X-API-Key: ts_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Sarah Chen-Smith",
    "skills": ["Python", "Go", "Rust", "AWS"]
  }'

curl -X DELETE https://cvparserpro.com/api/v1/candidates/{id} \
  -H "X-API-Key: ts_your_api_key"

{
  "success": true,
  "message": "Candidate deleted successfully"
}

curl "https://cvparserpro.com/api/v1/candidates/{id}/file" \
  -H "X-API-Key: ts_your_api_key"

{
  "data": {
    "url": "https://cvparserpro.supabase.co/storage/v1/object/sign/...",
    "filename": "sarah_chen_resume.pdf",
    "content_type": "application/pdf",
    "expires_at": "2026-01-28T02:39:09.804Z"
  }
}

curl "https://cvparserpro.com/api/v1/jobs?status=active&search=engineer" \
  -H "X-API-Key: ts_your_api_key"

curl -X POST https://cvparserpro.com/api/v1/jobs \
  -H "X-API-Key: ts_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Backend Engineer",
    "description": "We are looking for...",
    "required_skills": [
      {"skill": "Python", "weight": 1.0},
      {"skill": "PostgreSQL", "weight": 0.8}
    ],
    "nice_to_have_skills": [
      {"skill": "Docker", "weight": 0.5}
    ],
    "min_experience_years": 3,
    "max_experience_years": 8,
    "education_level": "bachelors",
    "preferred_locations": ["Remote", "Mexico City"],
    "salary_min": 80000,
    "salary_max": 120000
  }'

curl https://cvparserpro.com/api/v1/jobs/{id} \
  -H "X-API-Key: ts_your_api_key"

curl -X PATCH https://cvparserpro.com/api/v1/jobs/{id} \
  -H "X-API-Key: ts_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"status": "closed"}'

curl -X DELETE https://cvparserpro.com/api/v1/jobs/{id} \
  -H "X-API-Key: ts_your_api_key"

{
  "success": true,
  "message": "Job deleted successfully"
}

import requests

class CVParserPro:
    def __init__(self, api_key):
        self.api_key = api_key
        self.base_url = "https://cvparserpro.com/api/v1"
        self.headers = {"X-API-Key": api_key}

    def parse_cv(self, file_path):
        with open(file_path, "rb") as f:
            response = requests.post(
                f"{self.base_url}/parse",
                headers=self.headers,
                files={"files": f}
            )
        return response.json()

    def get_candidate(self, candidate_id):
        response = requests.get(
            f"{self.base_url}/candidates/{candidate_id}",
            headers=self.headers
        )
        return response.json()

    def list_candidates(self, page=1, limit=20):
        response = requests.get(
            f"{self.base_url}/candidates",
            headers=self.headers,
            params={"page": page, "limit": limit}
        )
        return response.json()

# Usage
client = CVParserPro("ts_your_api_key")
result = client.parse_cv("resume.pdf")
print(result)

class CVParserPro {
  constructor(apiKey) {
    this.apiKey = apiKey;
    this.baseUrl = 'https://cvparserpro.com/api/v1';
  }

  async parseCV(file) {
    const formData = new FormData();
    formData.append('files', file);

    const response = await fetch(`${this.baseUrl}/parse`, {
      method: 'POST',
      headers: { 'X-API-Key': this.apiKey },
      body: formData,
    });
    return response.json();
  }

  async getCandidate(id) {
    const response = await fetch(`${this.baseUrl}/candidates/${id}`, {
      headers: { 'X-API-Key': this.apiKey },
    });
    return response.json();
  }

  async listCandidates(page = 1, limit = 20) {
    const params = new URLSearchParams({ page, limit });
    const response = await fetch(`${this.baseUrl}/candidates?${params}`, {
      headers: { 'X-API-Key': this.apiKey },
    });
    return response.json();
  }
}

// Usage
const client = new CVParserPro('ts_your_api_key');
const result = await client.listCandidates();
console.log(result);