Documentation Index
Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt
Use this file to discover all available pages before exploring further.
Guide: Voice Agent with Video (Customer Service Rep)
Use case: Screening customer service candidates with a structured video interview. The AI interviewer asks 5 targeted questions, scores each response, and evaluates communication skills — all without any recruiter time. Ideal for mid-volume roles where you want to assess soft skills and verbal ability before a live interview.
What You’ll Build
A single-stage hiring pipeline:- Video Interview — An AI interviewer (Sarah) conducts a 5-question video interview. Candidates see a webcam-enabled interface, the AI asks questions conversationally with follow-ups, and each answer is scored on a 1–5 scale. You get a scorecard, transcript, and video recording.
Step 1: Create the Agent
Create a posting with a singleweb_interview workflow step. Setting "video": true enables the candidate’s webcam during the interview.
Tip: The
score_weight field controls how much each question contributes to the overall score. In this example, the de-escalation question (weight 3.0) counts twice as much as the motivation question (weight 1.5). The AI calculates an overall match score (0–100) using these weights.Step 2: Manage Questions After Creation
List all interview questions
Update a question’s scoring criteria
Perhaps after reviewing early results, you want to adjust the evaluation criteria for question 3:Reorder questions
Change the interview flow so the motivation question comes first:Step 3: Ingest Candidates
Single candidate
interview_url with the candidate via email, SMS, or your ATS. When they click it, they’ll see a video interview interface with Sarah as the interviewer.
Bulk ingest from your ATS export
Phone number is optional for video-only interviews. Candidates access the interview through the
interview_url link. However, if you want HeyMilo to send SMS reminders, include phone_number in the request.Step 4: See Results
List all candidates with scores
Get the full scorecard for a candidate
Key things to look at in the results
| Field | What It Tells You |
|---|---|
score | Overall weighted match score (0–100) |
speech_score | Communication quality rating |
scorecard[].evaluation_score | Per-question score (1–5) |
scorecard[].evaluation_summary | AI’s reasoning for the score |
highlights / lowlights | Quick strengths and areas for improvement |
video_recording_url | Watch the full interview yourself |
transcript | Read the complete conversation |
Set up webhooks
Get notified as soon as interviews are complete:Summary
| Step | Endpoint | What Happens |
|---|---|---|
| Create agent | POST /v4/postings | Video interview pipeline with 5 weighted questions |
| Manage questions | GET/POST/PATCH/DELETE /v4/postings/{id}/questions | Adjust questions, weights, and order at any time |
| Reorder questions | POST /v4/postings/{id}/questions/reorder | Change the interview question sequence |
| Ingest candidate | POST /v4/postings/{id}/candidates | Candidate receives an interview link |
| Candidate interviews | (automatic) | Sarah conducts a video interview with follow-ups |
| Get results | GET /v4/interviews/{id}/data | Scorecard, transcript, speech score, and recordings |
| Webhook | POST /v4/webhooks | Real-time notification when report is ready |