> ## 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.

# Índice da central de ajuda

> As coleções e os artigos publicados, na ordem da central.

Anônima: a central é da weve e explica o produto a quem administra um clube. O texto de cada
artigo é outra leitura.


## OpenAPI

````yaml GET /v1/help
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.useweve.com
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
  - name: terms
  - name: mcp
  - name: gamification
  - name: support
  - name: help
paths:
  /v1/help:
    get:
      tags:
        - help
      summary: O índice da central de ajuda
      description: |
        **Anônima.** A central de ajuda é da weve, não de um club: os artigos
        explicam o produto a quem administra, e são os mesmos para todo mundo.
        Por isso a rota não leva `{clubId}` nem sessão — a página pública da
        central e o painel de ajuda do dashboard leem a mesma coisa.

        Só aparece o que está PUBLICADO: o rascunho existe para quem escreve,
        e a consulta passa pela versão publicada de cada artigo, então não há
        como ele vazar por aqui. Coleção sem nenhum artigo publicado fica de
        fora — uma estante vazia na vitrine é uma promessa sem resposta.

        Os artigos vêm só com título e endereço; o texto é outra leitura
        (`GET /v1/help/articles/{slug}`), que é o que se paga por uma central
        com cem artigos e um leitor.

        A central é MULTI-IDIOMA: cada coleção e cada artigo é de uma língua,
        com endereço próprio nela. `translations` diz as outras línguas em que
        a mesma coleção existe — é o `hreflang` da página pública.
      operationId: getHelpIndex
      parameters:
        - $ref: '#/components/parameters/HelpLocale'
      responses:
        '200':
          description: As coleções, na ordem da central, com os artigos de cada uma
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelpIndex'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    HelpLocale:
      name: locale
      in: query
      description: O idioma da central. Sem ele, português.
      schema:
        $ref: '#/components/schemas/HelpLocale'
  schemas:
    HelpIndex:
      type: object
      required:
        - locale
        - collections
      properties:
        locale:
          $ref: '#/components/schemas/HelpLocale'
        collections:
          type: array
          items:
            $ref: '#/components/schemas/HelpCollection'
    HelpLocale:
      type: string
      description: |
        Os idiomas da central. Lista fechada: idioma novo precisa dos textos da
        interface na página pública antes do primeiro artigo.
      enum:
        - pt-BR
        - en
        - es
      default: pt-BR
    HelpCollection:
      type: object
      description: Um capítulo da central, com os artigos publicados nele.
      required:
        - slug
        - name
        - description
        - icon
        - articles
        - translations
      properties:
        slug:
          type: string
        name:
          type: string
        description:
          type: string
          description: Vazio quando a coleção não tem descrição.
        icon:
          type: string
          description: |
            O NOME de um ícone do catálogo fixo que as telas já carregam
            (`rocket`, `credit-card`…). Vazio é "sem ícone", e nome que a tela
            não conhece desenha o ícone padrão.
        articles:
          type: array
          items:
            $ref: '#/components/schemas/HelpArticleSummary'
        translations:
          type: array
          items:
            $ref: '#/components/schemas/HelpTranslation'
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    HelpArticleSummary:
      type: object
      required:
        - slug
        - title
      properties:
        slug:
          type: string
        title:
          type: string
    HelpTranslation:
      type: object
      description: A mesma coleção ou o mesmo artigo em outra língua.
      required:
        - locale
        - slug
      properties:
        locale:
          $ref: '#/components/schemas/HelpLocale'
        slug:
          type: string
  responses:
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'

````

## Related topics

- [Buscar na central de ajuda](/api-reference/help/search.md)
- [Ler um artigo da central](/api-reference/help/article.md)
- [Responder com o assistente](/api-reference/comments/managed-assistant-reply.md)
- [Agentes](/essentials/agents.md)
- [Marcar a conversa como lida](/api-reference/support/read.md)