> ## Documentation Index
> Fetch the complete documentation index at: https://omniloy.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Service status

> Checks that the service is operational. Useful for monitoring and infrastructure health checks.




## OpenAPI

````yaml /openapi/openapi-maria-en.yaml get /api/v1/health
openapi: 3.1.0
info:
  title: marIA API
  version: 1.0.0
  description: >
    marIA is Omniloy's voice agent that handles incoming patient calls at
    hospitals and clinics.

    - Voice / Telephony: the patient calls and marIA answers, manages
    appointments with the EHR/HIS, answers FAQs and escalates to a human when
    necessary.

    - WhatsApp Notifications: appointment confirmations and reminders via
    approved template.

    - Centers and services: consultation and management of centers, specialties
    and coverages configured in marIA.

    - FAQ Knowledge Base: documents that feed the agent's knowledge about
    centers and services.

    - Outbound calls and questionnaires: outbound scheduling and follow up
    questionnaires.

    - EHR/HIS integration via webhooks: marIA ⇄ Hospital for benefits, slots and
    appointments.

    - Webhook management: registration and configuration of endpoints to receive
    events from marIA.

    Top-level webhooks notify events (e.g. call status, appointments) signed
    with `webhookHmac`.
servers:
  - url: https://{your-prod-endpoint}
    description: Production
    variables:
      your-prod-endpoint:
        default: your-prod-endpoint
        description: Replace this value with the real host before trying the request.
  - url: https://{your-dev-endpoint}
    description: Staging
    variables:
      your-dev-endpoint:
        default: your-dev-endpoint
        description: Replace this value with the staging or development host.
security: []
tags:
  - name: Health
    description: Service status and availability.
  - name: Centers
    description: Medical centers with their services and coverages configured in marIA.
  - name: WhatsApp Notifications
    description: Sending appointment confirmations and reminders via WhatsApp template.
  - name: FAQ
    description: >-
      FAQ documents so the agent can answer questions about centers and
      services.
  - name: Webhooks - Appointments
    description: Appointment events integrated with the EHR/HIS.
  - name: Webhooks - Voice
    description: Telephony events (call status, escalation, answers and transcripts).
  - name: Voice Calls
    description: Inbound and outbound calls registered in MarIA Core.
  - name: Voice Answers
    description: Access and filtering of answers captured during calls.
  - name: Voice Transcripts
    description: Access to transcripts and recording links.
  - name: Content - Questionnaires
    description: Questionnaire definitions for outbound calls.
  - name: Questionnaire Instances
    description: Questionnaire instance status, review state, and results.
  - name: Scheduling - Time Ranges
    description: Reusable time ranges for scheduling calls.
  - name: Gestión de webhooks
    description: Webhook configuration and management; endpoints for integrators.
paths:
  /api/v1/health:
    get:
      tags:
        - Health
      summary: Service status
      description: >
        Checks that the service is operational. Useful for monitoring and
        infrastructure health checks.
      operationId: health-check
      responses:
        '200':
          description: Service operational
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: ok
                timestamp: '2025-09-01T10:00:00Z'
                uptime: 86400
                environment: production
components:
  schemas:
    HealthResponse:
      type: object
      description: Service health status.
      properties:
        status:
          type: string
          enum:
            - ok
          description: Service status.
        timestamp:
          type: string
          format: date-time
          description: Date and time of the check.
        uptime:
          type: number
          description: Seconds running.
        environment:
          type: string
          description: Environment (production, development…).
      required:
        - status

````