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

# Health check

> Returns the public service status. A healthy response only means the application is answering; it does not verify a model provider, payments, or backups.



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: OmniRelay API
  version: 1.0.0
  description: >-
    OpenAI-compatible gateway for reviewed real text models. Access is
    workspace-specific; query your own model list for capabilities and customer
    prices.
servers:
  - url: https://api.omnirelay.ai
security:
  - bearerAuth: []
tags:
  - name: Service
  - name: Models
  - name: Chat
  - name: Management
  - name: Responses
  - name: Embeddings
  - name: Images
  - name: Videos
paths:
  /health:
    get:
      tags:
        - Service
      summary: Health check
      description: >-
        Returns the public service status. A healthy response only means the
        application is answering; it does not verify a model provider, payments,
        or backups.
      operationId: getHealth
      responses:
        '200':
          description: The service is responding.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
              example:
                ok: true
                service: omnirelay
      security: []
components:
  schemas:
    Health:
      type: object
      required:
        - ok
        - service
      properties:
        ok:
          type: boolean
        service:
          type: string
          example: omnirelay
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key created in the OmniRelay console. The owner can view it again
        in the console after confirming their identity.

````

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