SharpAPI Resume Job Match Score analyzes how well a resume matches a job description, providing a compatibility score. Helps recruiters quickly identify the best candidates.
Supported resume files - 11 file formats: DOC, DOCX, TXT, RTF, PDF, JPG, JPEG, JPE, PNG, TIFF, TIF
And yes - it handles those flattened PDFs where the entire resume is just images instead of text.
- Requirements
- Installation
- Usage
- API Documentation
- Examples
- Use Cases
- API Endpoint
- Related Packages
- License
- Node.js >= 16.x
- npm or yarn
npm install @sharpapi/sharpapi-node-resume-job-match-scoreVisit SharpAPI.com to get your API key.
const { SharpApiResumeJobMatchScoreService } = require('@sharpapi/sharpapi-node-resume-job-match-score');
const apiKey = process.env.SHARP_API_KEY; // Store your API key in environment variables
const service = new SharpApiResumeJobMatchScoreService(apiKey);
const fs = require('fs');
const resumePath = './resume.pdf';
const jobDescription = 'Senior Software Engineer position...';
// Optional scoring directives (max 5000 chars). See "Context directives" below.
const context = `
EMPHASIZE: backend scalability
DEEMPHASIZE: frontend frameworks
CREDIT: AWS
`.trim();
async function calculateMatchScore() {
try {
// Submit matching job — language and context are optional
const statusUrl = await service.resumeJobMatchScore(resumePath, jobDescription, 'English', context);
console.log('Job submitted. Status URL:', statusUrl);
// Fetch results (polls automatically until complete)
const result = await service.fetchResults(statusUrl);
console.log('Match score:', result.getResultJson());
} catch (error) {
console.error('Error:', error.message);
}
}
calculateMatchScore();This service accepts file uploads. Please refer to the Postman Documentation for detailed parameter specifications.
The API returns structured data extracted from the uploaded file. See the product page for example responses.
const { SharpApiResumeJobMatchScoreService } = require('@sharpapi/sharpapi-node-resume-job-match-score');
const service = new SharpApiResumeJobMatchScoreService(process.env.SHARP_API_KEY);
// Customize polling behavior if needed
service.setApiJobStatusPollingInterval(10); // Poll every 10 seconds
service.setApiJobStatusPollingWait(180); // Wait up to 3 minutes
// Use the service
// ... (implementation depends on specific service)For more examples, visit the Product Page.
- Candidate Screening: Quickly identify top candidates
- Resume Ranking: Sort applicants by match score
- ATS Optimization: Improve candidate-job matching accuracy
- Recruitment Efficiency: Reduce time spent on unqualified candidates
- Job Seeker Tools: Help candidates understand fit for positions
- Talent Analytics: Analyze hiring patterns and candidate quality
The optional context parameter lets you steer the scoring engine using a formal directive contract. The engine recognises three directive shapes, which can be mixed freely in a single string:
| Directive | Effect |
|---|---|
EMPHASIZE: <topic> |
Increases the matching metric weight by one step |
DEEMPHASIZE: <topic> |
Decreases the matching metric weight by one step |
CREDIT: <skill | tool | certification> |
Treats the named item as a plausible role requirement even if it is absent from the job description |
Directives influence the overall_match score and the individual metric scores before the weighted average is computed.
Limit: the context string may be up to 5000 characters. Requests exceeding the limit fail with HTTP 422.
Example:
EMPHASIZE: backend scalability
DEEMPHASIZE: frontend frameworks
CREDIT: AWS
CREDIT: Kubernetes
POST /hr/resume_job_match_score
For detailed API specifications, refer to:
- @sharpapi/sharpapi-node-parse-resume
- @sharpapi/sharpapi-node-job-description
- @sharpapi/sharpapi-node-related-skills
This project is licensed under the MIT License. See the LICENSE.md file for details.
- Documentation: SharpAPI.com Documentation
- Issues: GitHub Issues
- Email: contact@sharpapi.com
Powered by SharpAPI - AI-Powered API Workflow Automation