Skip to content

Get started

HireLayer API documentation

Six recruiting APIs behind one API key: parse resumes, extract job criteria, score and rank resumes, search a talent pool, recommend jobs and normalize skills.

HireLayer is a set of REST APIs for developers who build ATS, job boards and HR tools, under https://hirelayer.co/api/v4. The most common call, ranking resumes for a job, is one request to the Resume Scorer: the quickstart shows it. Sign up for a self-serve key: the Free plan includes 50 credits a month and needs no card.

Base URL
https://hirelayer.co/api/v4
Authentication
X-API-Key header on every call except GET /health
Format
JSON in and out; files go as multipart/form-data, with the JSON in a request part when a call takes both
Errors
Always {"error": {"code", "message", "param", "doc_url"}}: branch on code
Workspaces
The optional HireLayer-Workspace header keeps each of your customers apart
Billing
Each endpoint states its price; the six products return credits_used. Failed work is not billed
Execution
Synchronous up to a size, then 202 with a signed webhook or a URL to read
Compatibility
Responses and webhooks can gain new fields as the products improve, and no existing field is ever removed or renamed: ignore the fields you do not know
Legacy parsers
/api/v3/parser and /api/v2/parser keep working with their JSON unchanged: see the legacy parsers

Every page is also available as Markdown by adding .md to its URL. /llms.txt indexes them, /llms-full.txt contains all of them, /openapi.json describes every endpoint, and /api-docs/agent-rules.md gives drop-in AGENTS.md rules for coding agents. All are generated from the same contract as these pages.