For Agents
Parse resumes and job descriptions, match candidates against requirements, and score candidate intelligence and retention risk via the Hirize AI HR API.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hirize Public API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Hirize Public API.
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
GET STARTED
Use for: I want to parse a resume PDF into structured fields, Match this candidate against the requirements of a specific job, Run candidate intelligence analysis on a parsed resume, Get the result of a previously submitted parser job
Not supported: Does not handle ATS pipeline management, interview scheduling, or payroll — use for AI resume parsing, matching, and HR scoring only.
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.
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
Patterns agents use Hirize Public API for, with concrete tasks.
★ 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.
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.
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.
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.
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 the Jentic vault, 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.
Parse a resume PDF, run HirizeIQ analysis on the parsed result, then match against parsed job id jd_456 and return the combined ranking.
11 endpoints — jentic publishes the only available openapi specification for hirize public api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
/api/public/parser
Parse a resume
/api/public/job-parser
Parse a job description
/api/public/ai-matcher
Match a resume against job requirements
/api/public/hirize-iq
Analyze candidate intelligence
/api/public/retain-me
Analyze employee retention risk
/api/public/parser
Parse a resume
/api/public/job-parser
Parse a job description
/api/public/ai-matcher
Match a resume against job requirements
/api/public/hirize-iq
Analyze candidate intelligence
/api/public/retain-me
Analyze employee retention risk
Three things that make agents converge on Jentic-routed access.
Credential isolation
The api_key query parameter is stored encrypted in the Jentic vault. Agents execute Hirize calls through Jentic and never read the raw key value.
Intent-based discovery
Agents search by intent (e.g., 'parse a resume') and Jentic returns the matching Hirize operation with its input schema, so the agent calls the right endpoint without browsing docs.
Time to first call
Direct Hirize integration: 1-2 days to wire auth, async polling, and webhook receipt. Through Jentic: under 1 hour — search, load schema, execute.
Alternatives and complements available in the Jentic catalogue.
Specific to using Hirize Public API through Jentic.
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 at https://app.jentic.com/sign-up.
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 the Jentic vault 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.