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

# Copiloto da aula

> O resumo da aula em pontos-chave, com o minuto do vídeo, e as tarefas para pôr em prática.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/classroom/lessons/{publicId}/copilot
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: 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
paths:
  /v1/clubs/{clubId}/classroom/lessons/{publicId}/copilot:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/PublicId'
    get:
      tags:
        - classroom
      summary: Lê o Copiloto da aula
      description: |
        O resumo da aula em pontos-chave — cada um com o segundo do vídeo em que
        começa, quando a aula tem transcrição — e as tarefas para pôr em
        prática, com o que a pessoa já marcou como feito. É gerado uma vez por
        aula, não por aluno. Exige as mesmas condições de abrir a aula.
        `404 copilot_not_found` quando a aula não tem Copiloto pronto — o
        `has_copilot` da aula já diz isso antes de perguntar.
      operationId: getClassroomLessonCopilot
      responses:
        '200':
          description: O Copiloto da aula
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassroomLessonCopilotResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - studentSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    PublicId:
      name: publicId
      in: path
      required: true
      description: A chave curta da URL do classroom.
      schema:
        type: string
        minLength: 1
        maxLength: 32
  schemas:
    ClassroomLessonCopilotResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ClassroomLessonCopilot'
    ClassroomLessonCopilot:
      type: object
      required:
        - summary
        - tasks
      properties:
        summary:
          type: array
          items:
            $ref: '#/components/schemas/CopilotPoint'
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/ClassroomCopilotTask'
    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
    CopilotPoint:
      type: object
      required:
        - text
      properties:
        text:
          type: string
          description: Um ponto-chave da aula, numa frase.
        start_seconds:
          type: integer
          description: O segundo do vídeo em que o ponto começa. Ausente sem transcrição.
    ClassroomCopilotTask:
      allOf:
        - $ref: '#/components/schemas/CopilotTask'
        - type: object
          required:
            - done
          properties:
            done:
              type: boolean
              description: Se a pessoa marcou como feita.
    CopilotTask:
      type: object
      required:
        - id
        - text
      properties:
        id:
          type: string
        text:
          type: string
          description: Uma tarefa concreta para pôr a aula em prática.
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      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'
  securitySchemes:
    studentSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de aluno, emitido por `/v1/auth/sign-in` e
        verificado contra a nossa tabela — não é JWT e não se lê nada dele.

        A ida ao banco não é custo novo: toda requisição autenticada já resolve
        o dono da sessão. Em troca, encerrar uma sessão vale no mesmo instante,
        sem lista de bloqueio nem janela de tolerância.

        O classroom o guarda em cookie **host-only**: um cookie de domínio o
        mandaria para os subdomínios dos outros clubs.

````

## Related topics

- [Marcar tarefa do Copiloto](/api-reference/classroom/lessons-copilot-task.md)
- [Ocultar o Copiloto de uma aula](/api-reference/agents/course-copilot-update.md)
- [Copiloto das aulas do curso](/api-reference/agents/course-copilot-list.md)
- [Refazer o Copiloto de uma aula](/api-reference/agents/course-copilot-regenerate.md)
- [Comentários da aula](/api-reference/comments/lesson-list.md)
