Available on all plans

Xzohra REST API

Integrate AI recruitment into your workflows. Analyze resumes, search candidates, manage jobs and scorecards â€” all through a simple REST API.

https://xzohra.com/v1/Get API Key

Authentication

All requests require an API key in the X-Api-Key header. Generate your key from Settings â†’ API in the dashboard.

X-Api-Key: xz_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

401

Missing or invalid API key

429

Rate limit exceeded

500

Internal server error

Rate Limits

Plan	Requests/minute
Free	30
Starter	100
Pro	500
Pro Plus	1000
Enterprise	5000

Endpoints

GET/v1/

Lists all available API endpoints and version info.

Example

curl "https://xzohra.com/v1/v1/" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

POST/v1/analyze-resume

Submit resume text for AI evaluation using your job scorecards. Returns per-criterion scores, total score, hireability signal, and shortlisting decision.

Request Body

{
  "resumeText": "John Doe\nSoftware Engineer with 5 years...",
  "jobDescription": "Looking for a senior backend engineer...",
  "jobId": "your_job_id",
  "candidateId": "cand_123",
  "scorecardId": "optional_scorecard_id"
}

Example

curl -X POST "https://xzohra.com/v1/v1/analyze-resume" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: xz_YOUR_API_KEY" \
  -d '{"resumeText":"...","jobDescription":"..."}'

GET/v1/jobs

Retrieve all your job postings with status and metadata.

Example

curl "https://xzohra.com/v1/v1/jobs" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

POST/v1/jobs

Create a new job posting programmatically.

Request Body

{
  "title": "Senior Backend Engineer",
  "description": "We are looking for...",
  "requirements": "Node.js, PostgreSQL, 5+ years",
  "company": "Your Company",
  "location": "Remote",
  "type": "full-time",
  "aiAutomationEnabled": true
}

Example

curl -X POST "https://xzohra.com/v1/v1/jobs" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: xz_YOUR_API_KEY" \
  -d '{"title":"Senior Backend Engineer","description":"..."}'

GET/v1/jobs/:jobId

Retrieve a specific job with full details.

Example

curl "https://xzohra.com/v1/v1/jobs/YOUR_JOB_ID" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

GET/v1/jobs/:jobId/applicants

Retrieve all applicants for a specific job with pipeline stage and AI scores.

Example

curl "https://xzohra.com/v1/v1/jobs/YOUR_JOB_ID/applicants" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

POST/v1/candidates/search

Semantic search across your candidate pool using natural language. Returns candidates ranked by relevance.

Request Body

{
  "query": "senior backend engineer with distributed systems experience",
  "skills": ["Node.js", "PostgreSQL"],
  "topK": 15
}

Example

curl -X POST "https://xzohra.com/v1/v1/candidates/search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: xz_YOUR_API_KEY" \
  -d '{"query":"backend engineer distributed systems"}'

POST/v1/candidates/similar

Find candidates similar to a given candidate using embedding similarity.

Request Body

{
  "candidateId": "cand_abc123",
  "topK": 10
}

Example

curl -X POST "https://xzohra.com/v1/v1/candidates/similar" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: xz_YOUR_API_KEY" \
  -d '{"candidateId":"cand_abc123"}'

GET/v1/analytics

Full analytics snapshot: pipeline funnel, velocity, bottlenecks, AI accuracy (F1/precision/recall), and KPIs.

Example

curl "https://xzohra.com/v1/v1/analytics" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

GET/v1/scorecards/:jobId

List all AI evaluation scorecards for a job.

Example

curl "https://xzohra.com/v1/v1/scorecards/YOUR_JOB_ID" \
  -H "X-Api-Key: xz_YOUR_API_KEY"

POST/v1/scorecards

Create a new AI evaluation scorecard with weighted criteria.

Request Body

{
  "jobId": "your_job_id",
  "name": "Engineering IC Screen",
  "criteria": [
    {"label":"Technical Skills","weight":50,"type":"ai_evaluation"},
    {"label":"Communication","weight":20,"type":"ai_evaluation"},
    {"label":"Culture","weight":30,"type":"ai_evaluation"}
  ],
  "shortlistThreshold": 65,
  "diversityBlind": true
}

Example

curl -X POST "https://xzohra.com/v1/v1/scorecards" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: xz_YOUR_API_KEY" \
  -d '{"jobId":"...","name":"My Scorecard","criteria":[...]}'

GET/v1/account

Get your account details, plan, and usage statistics.

Example

curl "https://xzohra.com/v1/v1/account" \
  -H "X-Api-Key: xz_YOUR_API_KEY"