score_jobs
Score job listings against a candidate profile. Returns match scores across seven dimensions. Credits: 3.0 per 50 jobs (minimum 3.0, cached results cost 25%)Modes
Inline Mode (up to 15 jobs)
Pass jobs directly in the request. Best for small batches.Batch Mode (up to 500 jobs)
For larger job sets, use the two-step batch flow:- Call
init_scoringto get an upload URL - Upload your jobs JSON file to the signed URL
- Call
score_jobswith thebatch_id
Inline Mode
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
jobs | array | Yes | 1-15 job objects to score |
expectations | object | Yes | Scoring context (see below) |
profile | string | Yes (first call) | Candidate resume/profile text (max 8,000 chars). Cached after first call. |
Expectations Object
| Field | Type | Required | Description |
|---|---|---|---|
target_roles | array | Yes | Target job titles |
locations | array | Yes | Preferred locations |
p1_cities | array | No | Priority 1 cities |
p2_cities | array | No | Priority 2 cities |
requires_visa | boolean | No | Whether visa sponsorship is needed |
country | string | No | Country code (default: gb) |
sector | string | No | Industry sector |
Request
Response
Score Dimensions
| Score | Range | Description |
|---|---|---|
match_score | 0-100 | Overall fit |
role_match | 0-100 | Job title alignment with target roles |
skill_match | 0-100 | Skills overlap with profile |
seniority_match | 0-100 | Experience level alignment |
salary_match | 0-100 | Salary vs. expectations |
location_priority | 0-100 | Location preference match |
sponsor_match | 0-100 | Visa sponsorship likelihood |
Batch Mode
init_scoring
Initialize batch scoring by requesting a signed upload URL. Credits: Free (charged onscore_jobs call)
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_count | number | Yes | Number of jobs (1-500) |
file_size | number | Yes | File size in bytes (100 - 5,242,880) |
expectations | object | Yes | Same as inline mode |
profile | string | No | Candidate profile (cached after first call) |
Request
Response
Upload and Score
Batch Response
download_url:
Batch Limits
| Limit | Value |
|---|---|
| Max jobs per batch | 500 |
| Max file size | 5 MB |
| Max concurrent batches | 3 |
| Batch expiry | 30 minutes after creation |