ZenHire API
This reference covers the ZenHire platform APIs, grouped into modules.
All endpoints authenticate with an X-API-Key header.
CV DeepMatch (platform.zenhire.ai/api/v1/cvdeepmatch) — asynchronous
CV ↔ job-description match scoring. Submit a CV (PDF) plus a job
description and a requirements config; poll for a structured score
breakdown.
Interview (platform.zenhire.ai/api/v1/interview) — AI voice
interviews. Create a reusable interviewer persona, start a per-candidate
session that mints a candidate link, then retrieve the recording (WAV) and
transcript (JSON) in-platform once the interview ends.
CV DeepSearch (platform.zenhire.ai/api/v1/cvds) — search a corpus of
parsed CVs for the best-matching candidates against a position. Ingest a
corpus once, then run repeated searches; poll the run or receive a webhook
for the best-first results.
Speech (platform.zenhire.ai/api/v1/speech) — asynchronous
speech-proficiency analysis. Upload an audio recording of an interview and
receive vocabulary, fluency, and accent scores aligned with the CEFR
framework. Submit returns an id; poll for results.
Jobs (platform.zenhire.ai/api/v1/jobs) — the saved-jobs catalog
shared by CV DeepMatch and CV DeepSearch. Save a job's description +
requirements config once, then reference it on run submits by your own
position_id or the platform job_id instead of re-sending the content.
Universal (platform.zenhire.ai/api/v1) — cross-module endpoints
shared by every module: credit balance (/api/v1/credits) and health
(/api/v1/health).
Pick a module from the sidebar to see its endpoints and schemas.
Authentication
- API Key: ApiKeyAuth
API key issued in the ZenHire dashboard. Format: zh_api_….
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |