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

# Verificar disponibilidade da API

> Endpoint publico para checagem de disponibilidade da API. Nao requer autenticacao.



## OpenAPI

````yaml /api-reference/openapi.pt.json get /healthz
openapi: 3.1.0
info:
  title: VZaps API publica
  version: 1.0.0
  description: >-
    Referencia oficial dos endpoints publicos da VZaps para instancias, billing
    e operacao da instancia (sessao, webhook, mensagens e demais).
servers:
  - url: https://api.vzaps.com
    description: Producao
security: []
tags:
  - name: Saude
  - name: Autenticacao
  - name: Instancias
  - name: Billing
  - name: Sessao
  - name: Webhook
  - name: Chat
  - name: Usuarios, avatar e contatos
    description: >-
      Consultas na rede WhatsApp (info, check), avatar e lista de contatos da
      conta; nao sao contas de usuario internas da plataforma VZaps.
  - name: Group
  - name: Contact
  - name: Queue
  - name: TypeBot
    description: >-
      Configuracao da integracao TypeBot por instancia (multi-flow, prioridade,
      sessoes).
  - name: Chatwoot
    description: >-
      Configuracao da integracao Chatwoot por instancia (canal bidirecional
      WhatsApp <-> Chatwoot).
  - name: Chats
    description: >-
      Metadados e acoes de chats WhatsApp (listar, arquivar, silenciar, fixar,
      ler, limpar e deletar).
paths:
  /healthz:
    get:
      tags:
        - Saude
      summary: Verificar disponibilidade da API
      description: >-
        Endpoint publico para checagem de disponibilidade da API. Nao requer
        autenticacao.
      operationId: healthz
      responses:
        '200':
          description: API disponivel
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  service:
                    type: string
                    example: vzaps-api
                required:
                  - status
                  - service
              example:
                status: ok
                service: vzaps-api
      security: []

````