HeyMilo

HeyMilo Health API

The Health API from HeyMilo — 1 operation(s) for health.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.heymilo.ai/api-reference/public-api/documentation
📖
APIReference
https://docs.heymilo.ai/api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/authentication/heymilo-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/openapi/heymilo-health-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/asyncapi/heymilo-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/errors/heymilo-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/conventions/heymilo-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/heymilo/refs/heads/main/data-model/heymilo-data-model.yml

OpenAPI Specification

heymilo-health-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: HeyMilo Public ATS Health API
  description: External developer-facing API for HeyMilo. Create interviewers with agentic workflows, ingest candidates, retrieve interview results, and manage workspace resources.
  version: 2.0.0
servers:
- url: https://api.heymilo.ai
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Health
paths:
  /health:
    get:
      tags:
      - Health
      summary: Health Check
      operationId: health_check_health_get
      parameters:
      - name: X-Health-Detail
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Health-Detail
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Health Check Health Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key for authentication. Pass your key in the X-API-KEY header.