Developers

API reference

Automate hiring end to end. Create jobs, invite candidates, pull scored reports, and react to events over a clean REST API.

Authentication

All requests are authenticated with a bearer API key generated from your dashboard. Keep keys secret and server-side.

Authorization header

Authorization: Bearer hs_live_xxxxxxxxxxxxxxxxxxxx

Base URL

All endpoints are relative to the API version base:

Base URL

https://api.aipl.online/api/v1

Endpoints

POST/jobsCreate a job with required competencies.

POST/candidatesAdd a candidate and (optionally) upload a resume.

POST/interviews/inviteGenerate a private interview link for a candidate.

GET/interviews/:id/reportRetrieve the scored report for a completed interview.

GET/candidates?jobId=List and rank candidates for a job.

Example — create a job

curl -X POST https://api.aipl.online/api/v1/jobs \
  -H "Authorization: Bearer $HIRESENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Frontend Engineer",
    "competencies": ["technical", "communication", "problem_solving"]
  }'

Webhooks

Subscribe to events to react in real time. Payloads are signed so you can verify authenticity.

Event payload

{
  "event": "interview.completed",
  "data": {
    "interviewId": "iv_9f2c...",
    "candidateId": "cd_1a4b...",
    "overallScore": 87,
    "recommendation": "strong_hire"
  }
}

Rate limits

The default limit is 600 requests per minute per key. Exceeding it returns 429 Too Many Requests with a Retry-After header.

Errors

Errors use standard HTTP status codes and a consistent JSON body:

Error response

{
  "success": false,
  "error": { "code": "not_found", "message": "Job not found" }
}

Need help integrating? Talk to our team.