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

# Ler um artigo da central

> O texto publicado de um artigo, em Markdown.

O rascunho não existe para quem lê: artigo nunca publicado, ou despublicado, responde 404.


## OpenAPI

````yaml GET /v1/help/articles/{slug}
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/articles/{slug}:
    parameters:
      - $ref: '#/components/parameters/HelpArticleSlug'
      - $ref: '#/components/parameters/HelpLocale'
    get:
      tags:
        - help
      summary: Um artigo publicado
      description: |
        **Anônima.** O texto da versão publicada, em Markdown. Artigo que
        nunca foi publicado, ou que foi despublicado, responde 404 igual ao
        que não existe: para quem lê, o rascunho não existe.

        O endereço é por idioma: o mesmo `slug` em outra língua é outro
        artigo. `translations` lista as traduções PUBLICADAS.
      operationId: getHelpArticle
      responses:
        '200':
          description: O artigo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelpArticle'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    HelpArticleSlug:
      name: slug
      in: path
      required: true
      description: O endereço do artigo — letras minúsculas, números e hífens.
      schema:
        type: string
        maxLength: 120
    HelpLocale:
      name: locale
      in: query
      description: O idioma da central. Sem ele, português.
      schema:
        $ref: '#/components/schemas/HelpLocale'
  schemas:
    HelpArticle:
      type: object
      required:
        - slug
        - locale
        - title
        - body_markdown
        - updated_at
        - collection
        - translations
      properties:
        slug:
          type: string
        locale:
          $ref: '#/components/schemas/HelpLocale'
        translations:
          type: array
          items:
            $ref: '#/components/schemas/HelpTranslation'
        title:
          type: string
        body_markdown:
          type: string
        updated_at:
          type: string
          format: date-time
          description: Quando a versão que está no ar foi publicada.
        collection:
          $ref: '#/components/schemas/HelpCollectionRef'
    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
    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
    HelpCollectionRef:
      type: object
      required:
        - slug
        - name
      properties:
        slug:
          type: string
        name:
          type: string
    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
  responses:
    NotFound:
      description: Recurso não encontrado
      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'

````

## Related topics

- [Índice da central de ajuda](/api-reference/help/index.md)
- [Buscar na central de ajuda](/api-reference/help/search.md)
- [Ler playbook](/api-reference/mentorships/playbook-get.md)
- [Ler repositório](/api-reference/content/repositories-get.md)
- [Ler curso](/api-reference/content/courses-get.md)