Skip to main content

Resume Parser API

The XeCubes AI Resume Parser extracts structured candidate entities from raw resumes (PDF, DOCX, TXT) and computes a multi-dimensional job suitability score against your job requirements.


1. Upload Resume for Analysis​

Submit a multipart form-data payload containing the candidate's resume and target job_id.

Form Parameters​

FieldTypeRequiredDescription
resumeFileYesPDF or DOCX resume document (Max size: 15MB).
job_idStringYesTarget Job UUID to score candidate against.
callback_urlStringNoHTTPS webhook URL to receive parser results when completed.
curl -X POST "https://api.xecubes.com/recruiter/jobs/vendor/resume-analysis" \
-H "X-API-Key: xh_live_your_secret_key" \
-F "resume=@/path/to/candidate_resume.pdf" \
-F "job_id=job_uuid_12345678" \
-F "callback_url=https://yourserver.com/webhooks/resume-parsed"

Immediate Queue Response​

{
"status": "success",
"message": "resume analysis created and queued",
"data": {
"analysis_id": "anal_987654321"
}
}

2. Retrieve Parser Status & Results​

Query the processing status and candidate extraction results using the analysis_id returned during upload.

curl -X GET "https://api.xecubes.com/recruiter/jobs/vendor/resume-analysis/anal_987654321" \
-H "X-API-Key: xh_live_your_secret_key"

Comprehensive Parsed Output​

{
"status": "success",
"data": {
"id": "anal_987654321",
"status": "completed",
"candidate": {
"name": "Sarah Connor",
"email": "sarah.connor@example.com",
"phone": "+1 415 555 0192",
"linkedin_url": "https://linkedin.com/in/sarahconnor",
"github_url": "https://github.com/sconnor",
"location": "San Francisco, CA"
},
"analysis": {
"suitability_score": 94.5,
"analysis_summary": "Exceptional fit for Senior AI Infrastructure role. Demonstrates 6+ years of distributed systems engineering, deep PyTorch experience, and high-throughput vector database deployments.",
"match_breakdown": {
"technical_skills": 96.0,
"experience_depth": 92.0,
"education_pedigree": 95.0
},
"key_skills": [
"Python",
"TypeScript",
"PgVector",
"PyTorch",
"Kubernetes",
"Distributed Systems"
],
"experience_years": 6.8,
"seniority_level": "Senior Staff"
}
}
}