HireFast AI | Recruitment Intelligence

Overview

The HireFast AI API allows ATS platforms like Ceipal to embed AI-powered recruitment intelligence directly into their workflows. For every job, access JD Analysis, Market Intelligence, Discovery Call Questions, Smart Sourcing, AI Interview links, and public share URLs — all via a simple REST API.

REST APIJSON ResponsesWebhook CallbacksRegion-Scoped

Authentication

Pass your API key in the X-API-Key header with every request. Keys are region-scoped (NA, UK_EMEA, APAC).

X-API-Key: hf_your_api_key_here

Rate Limit

100 requests per minute per API key

Key Generation

Admin only — from HireFast Settings

API Versioning

Set the X-API-Version header to pin your integration to a specific API version. If omitted, the version pinned to your API key at creation time is used. Every response includes X-API-Version, X-API-Latest-Version, and X-API-Supported-Versions headers.

X-API-Version: 2026-01-15

Current Version

2026-01-15

Supported

2026-01-15

Response Headers

X-API-VersionThe version used for this request

X-API-Latest-VersionThe newest available version

X-API-Supported-VersionsComma-separated list of all supported versions

X-API-Deprecation(Only if using an old version) Warning with upgrade instructions

When we release breaking changes, we publish a new version date. Your existing API keys continue to work with their pinned version. You can upgrade by sending the new version in the X-API-Version header or by generating a new key.

Getting Started

Contact your HireFast Admin to generate a region-scoped API key from Settings → API Integration

Store the API key securely — it is shown only once during generation

Add the key to your X-API-Key header in all API requests

Create a job: POST /api/v1/jobs with title + job_description

JD analysis starts automatically. Poll GET /api/v1/jobs/{id}/jd-analysis until status=completed

Trigger MI, Discovery, or Sourcing with ?generate=true on respective endpoints

Get all public share links: GET /api/v1/jobs/{id}/share-links

(Optional) Set up a webhook URL to get notified when reports complete instead of polling

Security

API keys are generated by HireFast Admins only — never share keys publicly

Each key is scoped to one region (NA, UK_EMEA, or APAC) — it can only access jobs in that region

Keys can be revoked instantly from Settings if compromised

Rate limit: 100 requests/minute per key

All API traffic is encrypted via HTTPS

Base URL

https://hirefast.tekwissen.in/api/v1

SANDBOXTest Without Affecting Live Data

Sandbox mode lets you test the full API integration flow without affecting live data or incurring LLM costs. Sandbox keys return instant mock responses with realistic sample data.

How to Use

Generate a Sandbox API key from Settings → API Integration → API Keys (select 'Sandbox' mode)

Use the sandbox key in your X-API-Key header — all endpoints work identically

Responses include "sandbox": true so you can detect test vs production data

Webhooks still fire with sandbox data — perfect for testing your receiver

Sandbox keys use the prefix hf_sandbox_ so they're easy to identify

What's Different in Sandbox

All AI analysis returns pre-built mock data instantly

No jobs or data written to the live database

Webhook notifications fire normally with sandbox payloads

Same 100 req/min limit applies to sandbox keys

Share URLs are demo links and won't resolve to real reports

API Endpoints

Webhook Events

When you configure a webhook URL on your API key, HireFast will send HTTP POST requests to that URL whenever an AI report finishes generating. This lets Ceipal know immediately when results are ready — no polling needed.

Delivery Details

Method: POST

Content-Type: application/json

Timeout: 10 seconds — your endpoint must respond within 10s

Retries: No automatic retries. Use the Test button in Settings to verify.

Custom Headers Sent:

Content-Typeapplication/json

X-HireFast-EventThe event type (e.g., jd_analysis.completed)

X-HireFast-DeliveryUnique delivery ID for idempotency

How to Set Up Webhooks

1. Log in to HireFast as Admin

2. Go to Settings → API Integration (Ceipal) → API Keys

3. Generate a new API key with your Webhook URL

4. Click 'Test' to verify your receiver gets the test.ping event

5. Start creating jobs via the API — you'll receive webhook events automatically