canonical: https://jentic.com/apis/hirize.hr/hirize

# Hirize Hr Hirize Public API

Jentic publishes the only available OpenAPI specification for Hirize Public API, keeping it validated and agent-ready. Hirize is an AI-powered HR platform that exposes resume parsing, job description parsing, candidate-to-job matching, candidate intelligence (HirizeIQ), and employee retention scoring (RetainMe). The API accepts PDF, JPG, and PNG inputs with built-in OCR and runs requests asynchronously, returning a result id that can be polled or delivered via webhook. It is designed to slot into ATS workflows where structured candidate data and match scores are needed at scale.

## For AI agents

Parse resumes and job descriptions, match candidates against requirements, and score candidate intelligence and retention risk via the Hirize AI HR API.

## Scope

Does not handle ATS pipeline management, interview scheduling, or payroll - use for AI resume parsing, matching, and HR scoring only.

## Capabilities

- Parse resumes from PDF, JPG, or PNG into structured candidate fields with OCR
- Parse job descriptions into structured role, skill, and requirement data
- Match a parsed resume against a parsed job description and return a fit score
- Run a HirizeIQ candidate intelligence analysis on parsed resume data
- Score employee retention risk with the RetainMe model for current employees
- Poll asynchronous results by id or receive them via configured webhooks

## Use cases

### Bulk Resume Parsing

Sourcing teams ingest thousands of resumes from email and job boards each week. Hirize's parser endpoint accepts each file (PDF, JPG, PNG) and returns structured candidate data with OCR support for scanned documents. The async result pattern means parsing scales without blocking the ingestion pipeline.

Example prompt: Submit a resume PDF to POST `/api/public/parser` and poll GET `/api/public/parser/{id}` until the structured result is ready.

### AI Candidate-Job Matching

Recruiters need a defensible match score between a candidate and a role rather than keyword matching. The AI matcher takes a parsed resume and a parsed job description and returns a fit score plus reasoning. Teams use this to rank long lists before human review.

Example prompt: Submit parsed resume id res_123 and parsed job id jd_456 to POST `/api/public/ai-matcher` and return the fit score.

### Candidate Intelligence Reports

Hiring managers want a richer signal than keywords on a CV. HirizeIQ produces a candidate intelligence report (skills depth, career trajectory, signal strength) from a parsed resume so reviewers see analysis, not just data. This is delivered async and can be webhooked into the ATS for fast turnaround.

Example prompt: Submit parsed resume id res_123 to POST `/api/public/hirize-iq` and retrieve the analysis via GET `/api/public/hirize-iq/{id}.`

### Employee Retention Forecasting

People-ops teams use RetainMe to score retention risk across current employees and target retention interventions. The agent submits employee-level signals via POST `/api/public/retain-me` and reads scored results back. This turns retention from anecdote into a ranked watchlist.

Example prompt: Submit retention input data for employee id emp_555 to POST `/api/public/retain-me` and retrieve the risk score.

### Agent-Run Sourcing Loop

An AI sourcing agent connected via Jentic ingests a resume, parses it, runs candidate intelligence, and matches against the open requisition - all within one workflow. Credentials live in your Jentic One instance, so the agent never sees the raw api_key query parameter. End-to-end setup is under an hour because operation schemas load on demand.

Example prompt: Parse a resume PDF, run HirizeIQ analysis on the parsed result, then match against parsed job id jd_456 and return the combined ranking.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/public/parser` | Parse a resume |
| POST | `/api/public/job-parser` | Parse a job description |
| POST | `/api/public/ai-matcher` | Match a resume against job requirements |
| POST | `/api/public/hirize-iq` | Analyze candidate intelligence |
| POST | `/api/public/retain-me` | Analyze employee retention risk |

## Key resources

- **Parser** — Resume parsing into structured candidate fields
- **Job Parser** — Job description parsing into structured form
- **AI Matcher** — Candidate-to-job fit scoring
- **Hirize IQ** — Candidate intelligence analysis
- **RetainMe** — Employee retention risk scoring

## Why Jentic

- **Setup:** Wiring the Hirize Public API by hand means managing an api_key that travels as a query-string parameter and posting documents to its parsing, matching, and scoring endpoints. Through Jentic you install once, import the Hirize Public API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Hirize Public API takes resume and job data in the request body rather than exposing scopable path ids, so scoping stays at the operation level: limit the agent to the operations it needs, such as parsing a resume or running the AI matcher. You choose that set, so a broader operation like the HR scoring call is only available if you include it.
- **Credential handling:** Your Hirize api_key is stored once, encrypted, by your own Jentic One instance and injected into the query string at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'parse a resume', and Jentic returns the matching Hirize operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Affinda API** — Affinda is a widely used resume parsing API with similar OCR support
- **OpenAI API** — General-purpose LLM that can extract resume fields without an HR-specific API
- **Ashby API** — ATS that consumes Hirize parsing and matching output as candidate data

## FAQ

### Why is there no official OpenAPI spec for Hirize Public API?

Hirize does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hirize Public API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Hirize Public API use?

Hirize uses an API key passed as the api_key query parameter on every request. Through Jentic, the api_key value is stored encrypted in your Jentic One instance and injected at execution time so agents never see the raw key.

### Can I parse scanned PDF resumes with the Hirize API?

Yes. POST `/api/public/parser` accepts PDF, JPG, and PNG inputs and runs OCR on scanned documents, so even photo or scan-based resumes parse into structured candidate fields.

### How do async results work in the Hirize API?

Each POST (parser, job-parser, ai-matcher, hirize-iq, retain-me) returns an id. Poll GET /{endpoint}/{id} until the result is ready, or configure a webhook so Hirize delivers the result automatically when processing completes.

### How do I run a candidate-to-job match through Jentic?

Search Jentic for 'match resume to job', load POST `/api/public/ai-matcher`, and execute with the parsed resume id and parsed job id. Use pip install jentic and the async SearchRequest, LoadRequest, ExecutionRequest pattern.

### What is the difference between HirizeIQ and the AI matcher?

The AI matcher returns a candidate-to-job fit score against a specific job. HirizeIQ runs candidate intelligence analysis on a resume independent of any job - it produces signal-rich insights about skills and trajectory that recruiters use during review.

### Can I limit what my agent is allowed to do with the Hirize API?

Yes. Because Jentic One is self-hosted, you decide which Hirize operations your agent may call and which credentials it may use. Since Hirize takes resume and job data in the request body rather than exposing scopable path ids, scoping stays at the operation level: you can allow only parsing a resume with POST `/api/public/parser` and the AI matcher while withholding broader calls like the RetainMe employee retention scoring. An operation such as the retention or HirizeIQ analysis is available to the agent only if you include it in the set you approve.