InterviewAI API
Create personalized interview sessions via API. Pass a user ID and questions — get back a unique interview link to share with your candidate.
How it works
Three simple steps to run an AI-powered interview.
1
POST to /api/create-interview
Send the candidate's user_id and your list of questions. Optionally include candidate name and job title.
2
Share the interview URL
You get back a unique link like /interview/emp_123. Send it to your candidate via email.
3
Candidate opens & speaks
They click Start, the AI greets them by name, asks all your questions, decides follow-ups automatically, and saves the full transcript.
API Reference
POST
/api/create-interview
Request body:
// Required "user_id": "emp_123", // unique ID for this candidate "questions": ["Q1...", "Q2..."], // list of interview questions // Optional "candidate_name": "John Smith", // AI greets by name "job_title": "Backend Engineer" // AI mentions the role
Response:
"success": true, "interview_url": "https://aiinterviewpython.bestworks.cloud/interview/emp_123", "user_id": "emp_123", "total_questions": 5, "created_at": "2025-01-01T12:00:00"
GET
/api/interview/<user_id>
Check interview status (pending / started / completed) and retrieve transcript after completion.
Try it live
Create an interview session right here and get a shareable link.