# HireLayer API

> HireLayer provides five recruiting REST APIs behind one API key: Extract (resume file → structured candidate JSON), Job Extract (job description → weighted criteria), Match (one candidate vs. one job, criterion by criterion), Rank (up to 10 candidates for one job) and Skills (free-text skills → reference catalog). Every call is synchronous; each successful call costs 1 credit.

- Base URL: https://onlineresumeparser.com/api — authenticate with the `X-API-Key` header.
- Every page below is Markdown. The HTML version is the same URL without `.md`.
- Documentation version: 2026-10-01.

## Get started

- [HireLayer API documentation](https://onlineresumeparser.com/api-docs.md): Five recruiting APIs behind one API key: parse resumes, extract job criteria, match and rank candidates, and normalize skills.
- [Quickstart](https://onlineresumeparser.com/api-docs/quickstart.md): Create an API key, check connectivity and parse a resume with cURL, Python or TypeScript in about five minutes.
- [Authentication](https://onlineresumeparser.com/api-docs/authentication.md): Authenticate every request with an X-API-Key header. Create, rotate and revoke keys from the dashboard.
- [Errors and retries](https://onlineresumeparser.com/api-docs/errors.md): Error format, every status code and message, and when to retry a HireLayer API call.
- [Limits and credits](https://onlineresumeparser.com/api-docs/limits.md): How credits are consumed, request size and batch limits, timeouts and concurrency guidance for the HireLayer APIs.

## APIs

- [HireLayer CV Extract](https://onlineresumeparser.com/api-docs/extract.md): Parse a resume file into structured candidate JSON with one multipart request: contact details, experience, education, languages and typed skills.
- [HireLayer Job Extract](https://onlineresumeparser.com/api-docs/job-extract.md): Extract explicit, weighted and mandatory criteria from a job description, ready to send to HireLayer Match.
- [HireLayer Match](https://onlineresumeparser.com/api-docs/match.md): Evaluate a resume against job criteria, criterion by criterion, with an explained status and a weighted 0–1 score.
- [HireLayer Rank](https://onlineresumeparser.com/api-docs/rank.md): Rank up to 10 candidates against one job description in a single call, with a score and a rationale for each.
- [HireLayer Skills](https://onlineresumeparser.com/api-docs/skills.md): Normalize free-text skills against the HireLayer catalog, one at a time or in batches of 100, and download the catalog.

## Guides

- [Build a screening pipeline](https://onlineresumeparser.com/api-docs/screening-pipeline.md): Chain HireLayer CV Extract, Job Extract, Rank and Match to parse resumes, score them against a job and explain the result.
- [Build with AI agents](https://onlineresumeparser.com/api-docs/ai-agents.md): Give Claude Code, Codex, Cursor or any coding agent the context it needs to integrate HireLayer correctly: llms.txt, Markdown pages, OpenAPI and a ready-made rules file.

## Reference

- [Health check](https://onlineresumeparser.com/api-docs/health.md): A public endpoint for uptime monitors and deployment checks. No API key and no credit needed.
- [CV Extract V2 (legacy)](https://onlineresumeparser.com/api-docs/extract-v2.md): Reference for the legacy asynchronous V2 resume parser. Kept for existing integrations; use V3 for new ones.

## Machine-readable

- [OpenAPI 3.1 (JSON)](https://onlineresumeparser.com/openapi.json): every endpoint, schema and error
- [OpenAPI 3.1 (YAML)](https://onlineresumeparser.com/openapi.yaml)
- [Agent rules](https://onlineresumeparser.com/api-docs/agent-rules.md): drop-in AGENTS.md / CLAUDE.md rules

## Optional

- [Full documentation](https://onlineresumeparser.com/llms-full.txt): every page above in one file