Universal concepts
The ZenHire API Platform is organized into four modules:
- Speech — asynchronous CEFR speech analysis.
- Interview — real-time AI voice interviews.
- CV DeepMatch — CV ↔ job-description match scoring.
- CV DeepSearch — corpus search: best-matching candidates for a position.
Everything on this page is shared by all four. Learn it once and it applies identically no matter which module you call. Module-specific behavior lives in each module's own section.
| Concept | What it covers | Where |
|---|---|---|
| Authentication | API keys, key types, the X-API-Key header, Projects | Every request |
| Identifiers | The single id run identifier, your own externalId correlation tag, and the per-response requestId | Every response |
| Error envelope | The one error shape every module returns: { error: { code, message, timestamp, requestId, details? } } | Every 4xx / 5xx |
| Credits | One shared credit ledger across all four modules | Billed work |
| Health | The single unauthenticated readiness endpoint | Monitoring |
Base URL
Every module shares one host:
https://platform.zenhire.ai
Each module is namespaced under /api/v1/<module>/…:
| Module | Path prefix |
|---|---|
| Speech | /api/v1/speech/… |
| Interview | /api/v1/interview/… |
| CV DeepMatch | /api/v1/cvdeepmatch/… |
| CV DeepSearch | /api/v1/cvds/… |
The two cross-module endpoints — credits and health — are not
owned by any single module and live directly under /api/v1:
| Endpoint | Path |
|---|---|
| Credits balance | GET /api/v1/credits |
| Health check | GET /api/v1/health |