Skip to main content
Version: 2.0.0

ZenHire Interview API

The Interview module is the ZenHire API Platform's third module, alongside Speech Analysis and CV DeepMatch. It lets you run AI voice interviews for your candidates without building or hosting any real-time infrastructure yourself.

The integration model is platform-as-control-plane:

  1. You create a reusable interviewer persona (role + interview language). The platform holds the persona configuration.
  2. You start a session against that persona for one candidate. The platform returns a candidate link carrying a single-use token.
  3. You hand the link to the candidate (email, SMS, your own UI). The candidate opens it, (optionally) consents, and talks to the AI interviewer in their browser — the real-time audio never touches your servers or ours' control plane.
  4. When the interview ends, the platform records the outcome and you review the recording + transcript in-platform.

Base URL​

All integrator endpoints are served from the API Platform:

https://platform.zenhire.ai/api/v1/interview

Authentication​

The eight integrator endpoints documented here are authenticated with an API key sent as the X-API-Key header — the same model used by Speech and CV DeepMatch. Your client must have the interview permission enabled; calls without it return 403 MISSING_PERMISSION. An API key is pinned to its own client (no cross-tenant access), and sessions you start with a key inherit that key's project association.

(The same paths also back the ZenHire console UIs, which authenticate with a logged-in browser session instead of a key. The two auth modes share one contract; this reference documents the X-API-Key mode.)

The lifecycle also involves server-to-server (S2S) steps between the platform and the ZenHire interview backend (candidate-token verification and the completion webhook). You never call these and are never given their secrets — they are noted only so you understand the full lifecycle.

Each session declares a consent_mode:

  • explicit — the candidate frontend shows a consent gate before the interview starts; ZenHire captures consent.
  • integrator — you (the ATS) have already captured consent contractually; no gate is shown.

Candidate voice recordings are sensitive PII. Pick the mode that matches your legal posture.

Authentication​

API key issued in the ZenHire dashboard, requiring the interview permission on your client. The console UIs that drive these endpoints use a logged-in session; X-API-Key is the headless equivalent (same model as Speech and CV DeepMatch).

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key