Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeyMilo Interviewers API

Create, read, update, and manage interviewers. An interviewer (posting) combines job details with an AI agent configuration and agentic workflow.

HeyMilo Interviewers API is one of 18 APIs that HeyMilo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Interviewers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 10 operations across 8 paths, and defines 29 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.

10 operations 8 paths 29 schemas 4 GET2 PATCH4 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 Interviewers 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 10

Across 8 paths, the API surfaces 10 operations — 4 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Interviewers 10

Create, read, update, and manage interviewers. An interviewer (posting) combines job details with an AI agent configuration and agentic workflow.

POST
/api/v2/postings
Create an interviewer
createPosting 3 params body → 201401404429422
GET
/api/v2/postings
List interviewers
listPostings 6 params → 200401404429422
GET
/api/v2/postings/list
List interviewer summaries
listPostingSummaries 6 params → 200401404429422
GET
/api/v2/postings/{posting_id}
Get an interviewer
getPosting 4 params → 200401404429422
PATCH
/api/v2/postings/{posting_id}
Update an interviewer
updatePosting 4 params body → 200401404429422
GET
/api/v2/postings/{posting_id}/stats
Get interviewer stats
getPostingStats 4 params → 200401404429422
PATCH
/api/v2/postings/{posting_id}/workflow/{step_id}
Update a workflow step's config
updateInterviewerWorkflowStep 5 params body → 200401404429422
POST
/api/v2/postings/{posting_id}/archive
Archive an interviewer
archivePosting 4 params → 200401404429422
POST
/api/v2/postings/{posting_id}/activate
Activate an interviewer
activatePosting 4 params → 200401404429422
POST
/api/v2/postings/{posting_id}/clone
Clone an interviewer
clonePosting 4 params → 201401404429422

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PostingResponse (36 properties), CreateQuestion (29 properties), CreatePostingRequest (26 properties), UpdatePostingRequest (24 properties). Each schema is shown below with its type and property counts.

PostingURLs
object
All URLs associated with a posting.
3 properties
CreatePostingRequest
object
26 properties 1 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
UpdateWorkflowStepRequest
object
Partial update of a workflow step's config.
1 property 1 required
_FormStep
object
Workflow step for form screening agent.
3 properties 1 required
_WebInterviewStep
object
Workflow step for webinterview agent.
3 properties 1 required
WorkflowStep
object
A single step in a posting's agentic workflow.
4 properties 2 required
_ResumeStep
object
Workflow step for resume screening agent.
3 properties 1 required
SingleResponse_CreatePostingResponse_
object
2 properties 1 required
HTTPValidationError
object
1 property
CreatePostingResponse
object
Response after successfully creating a posting.
6 properties 4 required
ListResponse_PostingSummary_
object
2 properties 2 required
UpdatePostingRequest
object
Request body for updating a posting. All fields are optional.
24 properties
WebInterviewConfig
object
Config for the webinterview agent.
17 properties
SingleResponse_PostingResponse_
object
2 properties 1 required
PostingSummary
object
Lightweight posting representation with only identifying fields.
4 properties 2 required
PostingStatsResponse
object
Aggregate statistics for a single posting. Returned in a single call without paginating the posting's candidates. The two score fields are independent per-agen…
8 properties 4 required
ListResponse_PostingResponse_
object
2 properties 2 required
APIErrorResponse
object
1 property 1 required
SingleResponse_PostingStatsResponse_
object
2 properties 1 required
PostingResponse
object
A job posting with its full agentic workflow configuration. A posting represents a complete hiring pipeline — it defines the job, the AI agents involved, and h…
36 properties 8 required
ResumeConfig
object
Config for the resume screening agent.
12 properties
PaginationMeta
object
3 properties 1 required
APIErrorDetail
object
3 properties 2 required
ConversationalSMSConfig
object
Config for the conversationalsms agent.
16 properties
FormConfig
object
Config for the form screening agent.
8 properties
_ConversationalSMSStep
object
Workflow step for conversationalsms agent.
3 properties 1 required
CreateQuestion
object
A question or criterion for a workflow step.
29 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-interviewers-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 Interviews API
HeyMilo Phone Numbers API
HeyMilo Questions API