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

# Health check

> Checks whether the API is running. Does not require authentication.



## OpenAPI

````yaml /api-reference/openapi.en.json get /v1/health
openapi: 3.1.0
info:
  title: Timely.ai API
  description: >-
    Timely.ai REST API for AI-powered customer service automation. Manage
    agents, conversations, contacts, and integrations.
  version: 1.0.0
  contact:
    name: Timely.ai
    email: contato@timelyai.com.br
    url: https://timelyai.com.br
servers:
  - url: https://api.timelyai.com.br
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health check and API key introspection
  - name: Agents
    description: AI agents — creation, configuration, and management
  - name: Trainings
    description: Agent knowledge bases
  - name: Channels
    description: Communication channels (WhatsApp, Telegram, Email, Website)
  - name: Contacts
    description: Customer records
  - name: Conversations
    description: Conversation history and messages
  - name: Custom Fields
    description: CRM custom fields
  - name: Chats
    description: Active chat operations and human handoff
  - name: Messages
    description: Individual messages
  - name: MCP
    description: Model Context Protocol — servers and tools
  - name: Webhooks
    description: Outbound webhooks for real-time events
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Health check
      description: Checks whether the API is running. Does not require authentication.
      operationId: healthCheck
      responses:
        '200':
          description: API is running
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  timestamp:
                    type: string
                    format: date-time
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key obtained from the dashboard

````