🔌 API Documentation

Developer API

Integrate InterviewAI into your hiring workflow with our powerful REST API.

Quick Start

Authenticate your requests with your API key in the header:

curl -X POST https://api.interviewai.com/v1/assessments \

-H "Authorization: Bearer YOUR_API_KEY" \

-H "Content-Type: application/json" \

-d '{"candidate_id": "abc123", "template": "senior-react"}'

POST/api/v1/assessmentsCreate a new assessment for a candidate

GET/api/v1/assessments/:idGet assessment details and results

POST/api/v1/candidatesRegister a new candidate

GET/api/v1/candidates/:id/resultsGet candidate's assessment results

POST/api/v1/questionsCreate custom question pools

GET/api/v1/analyticsGet hiring analytics and insights

POST/api/v1/webhooksConfigure webhook notifications

GET/api/v1/templatesList available assessment templates

Free

100 req/day

Pro

10,000 req/day

Enterprise

Unlimited