API v1

Interview Engine API

Integrate AI-powered interview capabilities into your platform. RESTful API with JSON responses.

Base URL
https://api.zushroom.com/v1
Authentication

Include your API key in the request header:

X-API-Key: your_api_key_here
Rate Limits
Free10 req/min50/month
Developer100 req/min1,000/month
Growth500 req/min10,000/month
EnterpriseCustomUnlimited
POST/interview/start

Start a new AI interview session.

Request Body
{
  "category": "tech",
  "sub_role": "Frontend Engineer",
  "candidate": {
    "name": "Priya Sharma",
    "skills": ["React", "TypeScript"],
    "experience_years": 2
  }
}
Response
{
  "interview_id": "iv_abc123",
  "message": {
    "interviewer": "A",
    "text": "Hello Priya. Tell me about..."
  },
  "audio_base64": "UklGRi..."
}
POST/interview/respond

Submit candidate's answer and receive next question.

Request Body
{
  "interview_id": "iv_abc123",
  "answer": "I believe my experience..."
}
Response
{
  "message": {
    "interviewer": "B",
    "action": "follow_up",
    "text": "Can you give a specific example?"
  },
  "question_count": 3,
  "completed": false
}
GET/interview/:id/evaluate

Get full evaluation after interview completion.

Response
{
  "scores": {
    "communication": 78,
    "confidence": 72,
    "clarity": 81,
    "knowledge": 69
  },
  "overall": 75,
  "strengths": ["Clear articulation..."],
  "improvements": ["Needs more examples..."],
  "transcript": [...]
}
POST/cv/parse

Parse a PDF CV and extract structured data.

Request Body
{
  "file_base64": "JVBERi0xL...",
  "filename": "resume.pdf"
}
Response
{
  "skills": [{"name": "React"}, ...],
  "experience": [{"role": "SDE", ...}],
  "education": [...],
  "projects": [...]
}

Ready to integrate?

Get your API key and start building in minutes.

Get API Key →View API Pricing →