# 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.

| Guide                                                                           | Workflow                                      | Role Type                       |
| ------------------------------------------------------------------------------- | --------------------------------------------- | ------------------------------- |
| [SMS to Voice Agent](/api-next-gen/guides/sms-to-voice-agent.md)                | SMS screening → Voice interview               | Blue collar (HVAC Technician)   |
| [Voice Agent (Video)](/api-next-gen/guides/voice-agent-video.md)                | Video interview with 5 questions              | Customer Service Representative |
| [Resume to Video Agent](/api-next-gen/guides/resume-to-video-agent.md)          | Resume screening → Video interview            | Software Engineer               |
| [Resume to Voice Agent](/api-next-gen/guides/resume-optional-to-voice-agent.md) | Resume screening (optional) → Voice interview | Sales 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:**

```json
{
  "object": "posting",
  "data": { ... }
}
```

**List of resources:**

```json
{
  "object": "list",
  "data": [ ... ],
  "has_more": false,
  "total_count": 5,
  "url": "/v4/postings"
}
```

**Error:**

```json
{
  "detail": "Error description"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.admin.heymilo.ai/api-next-gen/guides.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.