How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeyMilo Interviews API

Retrieve full interview results (scorecard, transcript, resume evaluation) and manage per-interview metadata.

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.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.heymilo.ai.

4 operations 2 paths 37 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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
getInterviewData 4 params → 200401404429422
GET
/api/v2/interviews/{interview_id}/metadata
Get interview metadata
getInterviewMetadata 4 params → 200401404429422
POST
/api/v2/interviews/{interview_id}/metadata
Set interview metadata
setInterviewMetadata 4 params body → 200401404429422
DELETE
/api/v2/interviews/{interview_id}/metadata
Delete interview metadata
deleteInterviewMetadata 4 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), WebInterviewResult (11 properties), ScorecardQuestion (11 properties), InterviewIntegrityResult (10 properties). Each schema is shown below with its type and property counts.

SingleResponse_InterviewDataResponse_
object
2 properties 1 required
HTTPValidationError
object
1 property
ResumeGptDetectionResult
object
AI-generation detection for the candidate's resume.
5 properties 2 required
CandidateWorkflow
object
Overall workflow progress for a candidate.
3 properties 2 required
ValidationError
object
3 properties 3 required
APIError
object
6 properties 3 required
LLMDetectedSegment
object
A transcript segment flagged as LLM-generated.
3 properties 3 required
ResumeScoreCriterion
object
Evaluation of a single resume scoring criterion.
5 properties 4 required
MetadataRequest
object
Request body for setting metadata on a resource.
1 property 1 required
GPTZeroMetrics
object
GPTZero scoring metrics for LLM detection.
3 properties 3 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
MetadataResponse
object
Response containing metadata for a resource.
2 properties 1 required
LLMDetectionResult
object
Detection of LLM-generated speech during the interview.
4 properties 2 required
IntegrityMovementEvent
object
A single eye/head/mouth movement event from video integrity analysis.
4 properties 1 required
TranscriptEntry
object
A single turn in an interview conversation.
4 properties 4 required
SMSMessage
object
A single message in an SMS screening conversation.
3 properties 2 required
IntegrityAggregated
object
Aggregated, time-sorted movement events from video integrity analysis.
1 property
InterviewIntegrityResult
object
Video integrity analysis (multiple people, eye/head tracking, phone, etc.).
10 properties
ResumeResult
object
Complete results for the resume screening step.
7 properties 1 required
WorkflowStepStatus
object
Status of a single workflow step for a candidate.
7 properties 5 required
SingleResponse_MetadataResponse_
object
2 properties 1 required
APIErrorDetail
object
3 properties 2 required
CheatingInstance
object
A single detected cheating occurrence with supporting evidence.
2 properties 1 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…
8 properties
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 properties 5 required
FormResult
object
Complete results for the form screening step.
4 properties 2 required
FormQuestionResult
object
Result of a single form screening question.
7 properties 5 required
SMSCriterionResult
object
Evaluation of a single SMS screening criterion.
6 properties 4 required
ResumeCheat
object
Cheat-detection signals for the resume step.
1 property
APIErrorResponse
object
1 property 1 required
SMSResult
object
Complete results for the SMS screening step.
8 properties 3 required
UnusualDelayResult
object
Detection of unusual response delays (possible external assistance).
5 properties 4 required
TranscriptCheatResult
object
Transcript-based cheat detection (AI/scripted answers).
3 properties 2 required
ScorecardQuestion
object
Evaluation result for a single scored question.
11 properties 6 required
WebInterviewResult
object
Complete results for the web interview (voice/video) step.
11 properties 2 required
ResumeEligibilityCriterion
object
Evaluation of a single resume eligibility (pass/fail) criterion.
5 properties 4 required
CheatTranscriptReference
object
A transcript snippet referenced by a cheating instance.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-interviews-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

HeyMilo ATS API
HeyMilo Candidates API
HeyMilo Design Template Groups API
HeyMilo Design Templates API
HeyMilo Domains API
HeyMilo Email Template Groups API
HeyMilo Email Templates API
HeyMilo Health API
HeyMilo Interview Templates API
HeyMilo Interviewers API
HeyMilo Phone Numbers API
HeyMilo Questions API
Where this information came from

This is an independent, third-party profile of HeyMilo Interviews API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.