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

# Buscar na central de ajuda

> Busca por palavra nos artigos publicados, sem acento e pelo começo da palavra.

A última palavra vale como prefixo — `reemb` já acha "reembolso" —, e a busca ignora acento e
plural. O trecho marca o que casou entre `«` e `»`.


## OpenAPI

````yaml GET /v1/help/search
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/search:
    get:
      tags:
        - help
      summary: Busca nos artigos publicados
      description: |
        **Anônima**, como o índice. Busca por palavra no título e no corpo da
        versão publicada — o título pesa mais que o corpo. Devolve no máximo
        20 artigos, os mais relevantes primeiro, com um trecho do corpo em
        volta do que casou.

        O trecho marca as palavras encontradas entre `«` e `»`; quem desenha
        decide como destacá-las. Texto puro, nada de HTML. Busca só no idioma
        pedido.
      operationId: searchHelp
      parameters:
        - $ref: '#/components/parameters/HelpLocale'
        - name: q
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
      responses:
        '200':
          description: Os artigos encontrados (a lista pode vir vazia)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelpSearchResults'
        '400':
          $ref: '#/components/responses/BadRequest'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '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:
    HelpSearchResults:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/HelpSearchHit'
    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
    HelpSearchHit:
      type: object
      required:
        - slug
        - title
        - snippet
        - collection
      properties:
        slug:
          type: string
        title:
          type: string
        snippet:
          type: string
          description: |
            Um trecho do corpo em volta do que casou, com as palavras
            encontradas entre `«` e `»`.
        collection:
          $ref: '#/components/schemas/HelpCollectionRef'
    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
    HelpCollectionRef:
      type: object
      required:
        - slug
        - name
      properties:
        slug:
          type: string
        name:
          type: string
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    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'

````