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

# Service health

> Read the gateway health response.



## OpenAPI

````yaml GET /health
openapi: 3.1.1
info:
  title: AVRXT Public API
  version: v1
  description: >-
    The public AVRXT API gateway. Use HTTPS and JSON for all requests and
    responses.
  contact:
    name: AVRXT
    url: https://www.avrxt.dev/contact
  license:
    name: AVRXT Terms
    url: https://www.avrxt.dev/legal/terms
servers:
  - url: https://api.avrxt.dev/v1
    description: Production
security: []
tags:
  - name: System
    description: Service availability and public status.
  - name: Content
    description: Public metadata and media output.
  - name: Integrations
    description: Read-only public integration data.
externalDocs:
  description: AVRXT API reference
  url: https://docs.avrxt.dev/api-reference/overview
paths:
  /health:
    get:
      tags:
        - System
      summary: Check API health
      operationId: getHealth
      responses:
        '200':
          description: The API is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Health:
      type: object
      required:
        - status
        - timestamp
      properties:
        status:
          type: string
          example: healthy
        timestamp:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    ServiceUnavailable:
      description: The service or an upstream integration is unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.