Skip to main content

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.

​
API Guides

Step-by-step walkthroughs for common hiring workflows using the HeyMilo Next Gen API. Each guide covers the full lifecycle: creating the agent, ingesting candidates, and retrieving results.
GuideWorkflowRole Type
SMS to Voice AgentSMS screening → Voice interviewBlue collar (HVAC Technician)
Voice Agent (Video)Video interview with 5 questionsCustomer Service Representative
Resume to Video AgentResume screening → Video interviewSoftware Engineer
Resume to Voice AgentResume screening (optional) → Voice interviewSales Representative

​
Prerequisites

Before following any guide, make sure you have:
  1. API Key - Generate one from Integrations > API Keys in the HeyMilo dashboard, or use an existing key.
  2. Base URL - All requests go to: 
    https://api.heymilo.network
  3. Authentication - Include your API key in every request: 
    X-API-KEY: your_api_key_here

​
Common Patterns

All Next Gen API responses follow a consistent envelope: Single resource: 
{
  "object": "posting",
  "data": { ... }
}
List of resources: 
{
  "object": "list",
  "data": [ ... ],
  "has_more": false,
  "total_count": 5,
  "url": "/v4/postings"
}
Error: 
{
  "detail": "Error description"
}