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

# Estado da API

> Healthcheck da API e das dependências.



## OpenAPI

````yaml GET /health
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: students
  - name: auth
paths:
  /health:
    get:
      tags:
        - health
      summary: Estado da API e das suas dependências
      operationId: getHealth
      responses:
        '200':
          description: >-
            A API respondeu. `status` é sempre "ok" — o que degrada é cada
            dependência, em seu próprio bloco.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
components:
  schemas:
    HealthStatus:
      type: object
      required:
        - status
        - database
        - cache
      properties:
        status:
          type: string
        database:
          $ref: '#/components/schemas/DependencyStatus'
        cache:
          $ref: '#/components/schemas/DependencyStatus'
    DependencyStatus:
      type: object
      description: >-
        Estado de uma dependência. `status` é up, down ou disabled; os demais
        campos variam por dependência.
      required:
        - status
      additionalProperties:
        type: string
      properties:
        status:
          type: string

````

## Related topics

- [Biblioteca de mídia](/essentials/media.md)
- [Reprocessar evento](/api-reference/webhooks/events-reprocess.md)
- [Aviso do provedor de vídeo](/api-reference/media/webhook.md)
- [Encerrar sessão](/api-reference/auth/sign-out.md)
- [Quem sou eu](/api-reference/me.md)