HeyMilo Interviews API is one of 18 APIs that HeyMilo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Interviews. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
4 operations
across 2 paths,
and defines 37 schemas.
It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.heymilo.ai.
4 operations2 paths37 schemas1 DELETE2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.heymilo.ai
Authentication
API Key
Resource Areas
1
Authentication & Security 1
HeyMilo Interviews API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-KEY (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth — API key for authentication. Pass your key in the X-API-KEY header.
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Interviews 4
Retrieve full interview results (scorecard, transcript, resume evaluation) and manage per-interview metadata.
GET
/api/v2/interviews/{interview_id}/data
Get full interview data
getInterviewData4 params→ 200401404429422
GET
/api/v2/interviews/{interview_id}/metadata
Get interview metadata
getInterviewMetadata4 params→ 200401404429422
POST
/api/v2/interviews/{interview_id}/metadata
Set interview metadata
setInterviewMetadata4 paramsbody→ 200401404429422
DELETE
/api/v2/interviews/{interview_id}/metadata
Delete interview metadata
deleteInterviewMetadata4 params→ 200401404429422
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are InterviewDataResponse (16 properties), ScorecardQuestion (11 properties), WebInterviewResult (11 properties), InterviewIntegrityResult (10 properties). Each schema is shown below with its type and property counts.
InterviewDataResponse
object
Full interview results across all workflow steps. Contains the candidate details plus per-agent results. Fields for agents not in the posting's workflow will b…
16 properties5 required
APIError
object
6 properties3 required
ValidationError
object
3 properties3 required
UnusualDelayResult
object
Detection of unusual response delays (possible external assistance).
5 properties4 required
CheatingInstance
object
A single detected cheating occurrence with supporting evidence.
2 properties1 required
SMSCriterionResult
object
Evaluation of a single SMS screening criterion.
6 properties4 required
CheatDetection
object
Aggregated cheat / integrity detection across interview steps. Present only when the posting has cheat detection configured. When enabled is false, detection s…
A single message in an SMS screening conversation.
3 properties2 required
IntegrityAggregated
object
Aggregated, time-sorted movement events from video integrity analysis.
1 property
ScorecardQuestion
object
Evaluation result for a single scored question.
11 properties6 required
MetadataRequest
object
Request body for setting metadata on a resource.
1 property1 required
SingleResponse_InterviewDataResponse_
object
2 properties1 required
GPTZeroMetrics
object
GPTZero scoring metrics for LLM detection.
3 properties3 required
APIErrorResponse
object
1 property1 required
ResumeScoreCriterion
object
Evaluation of a single resume scoring criterion.
5 properties4 required
LLMDetectionResult
object
Detection of LLM-generated speech during the interview.
4 properties2 required
IntegrityMovementEvent
object
A single eye/head/mouth movement event from video integrity analysis.
4 properties1 required
ResumeEligibilityCriterion
object
Evaluation of a single resume eligibility (pass/fail) criterion.
5 properties4 required
CandidateWorkflow
object
Overall workflow progress for a candidate.
3 properties2 required
TranscriptEntry
object
A single turn in an interview conversation.
4 properties4 required
FormQuestionResult
object
Result of a single form screening question.
7 properties5 required
ResumeResult
object
Complete results for the resume screening step.
7 properties1 required
WebInterviewResult
object
Complete results for the web interview (voice/video) step.
11 properties2 required
APIErrorDetail
object
3 properties2 required
WebInterviewCheat
object
Cheat-detection signals for the web (voice/video) interview step. Carries both the v1 detection signals (transcript / LLM / unusual-delay / video-integrity) an…
6 properties
FormResult
object
Complete results for the form screening step.
4 properties2 required
CheatTranscriptReference
object
A transcript snippet referenced by a cheating instance.
3 properties3 required
SMSResult
object
Complete results for the SMS screening step.
8 properties3 required
ResumeGptDetectionResult
object
AI-generation detection for the candidate's resume.
5 properties2 required
InterviewIntegrityResult
object
Video integrity analysis (multiple people, eye/head tracking, phone, etc.).
10 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
