Changelog and versioning

What has shipped, and what we promise not to break.

Versioning policy

The version is in the path: /v1. Everything in this documentation is v1.
Not breaking (can happen at any time): new endpoints, new optional request fields, new fields in responses, new error codes, new event types, new enum values, new scopes. Write clients that ignore unknown fields and handle unknown codes gracefully.
Breaking (only in a new version): removing or renaming a field, endpoint or scope, changing a field's type or meaning, making an optional parameter required, changing credit costs for an existing call upward without notice.
When a new version is released, the previous one keeps running in parallel for a transition period and active keys are told in advance.
Credit and plan prices can change; existing subscribers are told before their next period starts.

Search and match: ranked candidate search with filters, job-description matching with must-have extraction and fit bands, single-candidate fit scoring.
Records: full candidate records with scope-gated contact, compensation and document fields; 10-minute resume links; an access log for every release of personal fields.
Parsing: resume to structured JSON, job description to requirement checklist.
Market intelligence: pay bands from curated benchmarks and observed self-reported pay with confidence levels, skills around a role, pool overview, and open roles.
Billing: fixed monthly INR plans (Pro, Pro Scale, and arranged Client plans) with credits, top-ups, a grace window, and Cashfree checkout; GST added at checkout.
Reliability: Idempotency-Key on every POST, exact per-minute rate limits, automatic refunds on server errors, request ids on every response.
Webhooks: signed events for credits and subscription with retries and delivery logs.
MCP server: the same tools for Claude, Cursor and other agents at /v1/mcp.
Platform: OpenAPI 3.1 spec, live and test (synthetic) keys, optional IP allowlists, a global edge gateway at api.helixhumancapital.in.