> ## Documentation Index > Fetch the complete documentation index at: https://docs.useweve.com/llms.txt > Use this file to discover all available pages before exploring further. # Assistir aula > Corpo, vídeo e navegação; exige direito e liberação. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/classroom/lessons/{publicId} 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/clubs/{clubId}/classroom/lessons/{publicId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/PublicId' get: tags: - classroom summary: A aula, para assistir description: | O corpo, o vídeo e a navegação (anterior e próxima na ordem do curso). Só para quem tem direito E para quem a agenda já liberou: sem direito é 403 `not_entitled`; liberação pendente é 403 `not_released`, com a data na mensagem. operationId: getClassroomLesson responses: '200': description: A aula content: application/json: schema: $ref: '#/components/schemas/ClassroomLessonResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '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: ClassroomLessonResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClassroomLesson' ClassroomLesson: type: object required: - public_id - title - type - course_public_id - module_title - progress properties: public_id: type: string title: type: string type: $ref: '#/components/schemas/LessonType' description: type: string body: description: | O documento do editor ANTIGO, mantido para quem já o lia. O conteúdo da aula hoje são os `blocks`. deprecated: true blocks: description: | O corpo da aula, na ordem montada no editor. O vídeo ou áudio principal vem marcado `main` (ele já é o `playback`), e os PDF e arquivos também estão em `attachments`. Quiz, entrega e pergunta ficam de fora até a resposta do aluno existir. type: array items: $ref: '#/components/schemas/ClassroomBlock' playback: $ref: '#/components/schemas/Playback' description: | O que tocar, com o endereço assinado no momento da resposta. Ele expira: o player deve carregar já, e recarregar a página quando voltar depois. attachments: description: Os materiais da aula, com endereço assinado pelo mesmo prazo. type: array items: $ref: '#/components/schemas/Playback' downloadable: description: | Se a tela oferece o download dos materiais. Falso, eles só abrem no navegador. type: boolean duration_seconds: type: integer course_public_id: type: string module_title: type: string previous_public_id: type: string next_public_id: type: string comments_enabled: description: | Se a conversa embaixo da aula está aberta. Falso quando o curso ou a aula a desligou — e aí a tela NÃO desenha o campo, em vez de oferecer um que responderia 409. type: boolean chapters: description: | Os capítulos do vídeo principal, em ordem de tempo — os mesmos que a equipe marca no bloco de vídeo. Ausente quando não há. type: array items: $ref: '#/components/schemas/VideoChapter' has_transcript: description: | Se há transcrição pronta do vídeo principal, com o tempo de cada trecho (`GET .../transcript`). A leitura não dispara transcrição: transcrever é pago, e quem decide pagar é o club. type: boolean saved: description: Se a pessoa salvou esta aula para voltar depois. type: boolean can_ask: description: | Se há quem responda sobre esta aula ("Perguntar"): o assistente do curso está ligado e o ambiente tem o modelo. Falso, a tela não mostra o botão. type: boolean has_copilot: description: > Se a aula tem Copiloto pronto — resumo e prática (`GET .../copilot`). Falso, a tela não mostra a aba. type: boolean progress: $ref: '#/components/schemas/LessonProgress' 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 LessonType: type: string enum: - video - text - audio - file ClassroomBlock: description: Um bloco do corpo da aula, como o aluno o vê. type: object required: - id - kind properties: id: type: string format: uuid kind: $ref: '#/components/schemas/ClassroomBlockKind' label: description: O título que a equipe deu ao bloco. No `link`, é o texto do link. type: string text: description: No `text`, Markdown; na `image`, a legenda (texto puro). type: string url: description: O endereço do `link`, ou o do player do `embed`. type: string provider: $ref: '#/components/schemas/MediaProvider' description: De quem é o `embed` — decide como montar o player. main: description: | Verdadeiro no vídeo/áudio que já é o `playback` da aula: a tela não o repete no corpo. type: boolean media: $ref: '#/components/schemas/Playback' description: O vídeo ou áudio que NÃO é o principal, assinado. files: description: >- As imagens da `image` ou os arquivos de `pdf`/`file`, assinados e em ordem. type: array items: $ref: '#/components/schemas/Playback' quiz: $ref: '#/components/schemas/ClassroomQuiz' description: O quiz do bloco `quiz`, sem o gabarito. assignment: $ref: '#/components/schemas/ClassroomAssignment' description: A entrega do bloco `assignment`; as instruções são o `text`. Playback: description: | A entrega, assinada no momento em que sai e com prazo curto. Não é guardada em coluna nem em cache — link assinado dentro de cache é link que expira guardado. type: object required: - kind - provider - url - expires_at - signed properties: kind: $ref: '#/components/schemas/MediaKind' provider: $ref: '#/components/schemas/MediaProvider' url: description: A playlist HLS, o arquivo, ou o id/URL de quem é de fora. type: string thumbnail_url: type: string duration_seconds: type: integer title: type: string size_bytes: description: >- O tamanho do arquivo, quando conhecido — é o "PDF · 640 KB" do material. type: integer format: int64 expires_at: type: string format: date-time signed: description: | Falso quando a entrega é aberta — mídia pública, ou zona de vídeo sem chave de token. A resposta não finge proteção que não existe. type: boolean VideoChapter: type: object required: - at_seconds - title properties: at_seconds: type: integer minimum: 0 title: type: string minLength: 1 maxLength: 120 LessonProgress: type: object required: - completed - last_position_seconds properties: completed: type: boolean completed_at: type: string format: date-time last_position_seconds: type: integer ClassroomBlockKind: type: string enum: - video - audio - image - text - pdf - file - link - embed - quiz - assignment x-enum-varnames: - ClassroomBlockVideo - ClassroomBlockAudio - ClassroomBlockImage - ClassroomBlockText - ClassroomBlockPdf - ClassroomBlockFile - ClassroomBlockLink - ClassroomBlockEmbed - ClassroomBlockQuiz - ClassroomBlockAssignment MediaProvider: description: | Onde o bit mora. `bunny_stream` é o vídeo que hospedamos e `r2` o arquivo; `youtube`, `vimeo` e `external` são referências a algo de fora, que a biblioteca guarda para a aula ter um caminho só. `safevideo` é o vídeo guardado no SafeVideo, que a extensão de mesmo nome traz: o player é o deles, e a entrega ao aluno sai com a marca d'água dele. type: string enum: - bunny_stream - r2 - youtube - vimeo - external - safevideo ClassroomQuiz: description: | O quiz como o aluno o responde. As alternativas vêm SEM o gabarito: quem diz o que é certo é a conferência (`/check`) e a tentativa. A ordem já vem embaralhada quando o bloco pede. type: object required: - passing_score - required - requirement - show_correct_answers - questions properties: passing_score: description: A nota mínima para passar, em por cento. type: integer required: description: A aula só conclui quando o quiz for cumprido. type: boolean requirement: description: | O que "cumprir" quer dizer: `completed` é terminar com qualquer nota; `passed` é atingir a nota mínima. type: string enum: - completed - passed show_correct_answers: description: A conferência e o resultado mostram as certas e a explicação. type: boolean questions: type: array items: $ref: '#/components/schemas/ClassroomQuizQuestion' summary: $ref: '#/components/schemas/QuizAttemptSummary' ClassroomAssignment: description: A entrega como o aluno a vê — o que a aula pede, e o que ele já mandou. type: object required: - accepts_files - accepts_text - max_files - required properties: accepts_files: type: boolean accepts_text: type: boolean max_files: type: integer required: description: A aula só conclui com a entrega feita. type: boolean due_at: description: | O prazo DESTE aluno: os dias do bloco contados de quando a aula liberou para ele. Ausente, não há prazo. type: string format: date-time submission: $ref: '#/components/schemas/StudentSubmission' MediaKind: description: Rótulo de tela — o ícone e o filtro. Nada de acesso lê isto. type: string enum: - video - audio - image - document ClassroomQuizQuestion: type: object required: - id - kind - text - points - options properties: id: type: string format: uuid kind: $ref: '#/components/schemas/QuizQuestionKind' text: type: string points: description: | Quanto a pergunta vale na nota. Com todas valendo o mesmo, a tela diz "acerte 3"; com pesos diferentes, fala em porcentagem. type: integer options: type: array items: $ref: '#/components/schemas/ClassroomQuizOption' QuizAttemptSummary: description: | As tentativas do aluno neste quiz. Ausente, ele ainda não tentou. type: object required: - attempts - best_score - passed - last_at properties: attempts: type: integer best_score: description: A melhor nota, em por cento — é a que conta. type: integer passed: description: Alguma tentativa atingiu a nota mínima. type: boolean last_at: type: string format: date-time StudentSubmission: type: object required: - id - status - files - submitted_at - late properties: id: type: string format: uuid status: $ref: '#/components/schemas/SubmissionStatus' text: type: string files: description: Os arquivos enviados, na ordem, assinados. type: array items: $ref: '#/components/schemas/SubmissionFile' submitted_at: type: string format: date-time late: description: Enviada depois do prazo que valia no envio. type: boolean feedback: description: O comentário da última correção. type: string reviewed_at: type: string format: date-time QuizQuestionKind: description: | `single_choice` aceita UMA alternativa certa; `multiple_choice`, mais de uma — e o aluno só acerta marcando exatamente as certas. type: string enum: - single_choice - multiple_choice ClassroomQuizOption: type: object required: - id - text properties: id: type: string format: uuid text: type: string SubmissionStatus: description: | `submitted` espera correção; `approved` foi aprovada e não muda mais; `changes_requested` voltou para o aluno refazer. type: string enum: - submitted - approved - changes_requested x-enum-varnames: - SubmissionSubmitted - SubmissionApproved - SubmissionChangesRequested SubmissionFile: type: object required: - media_id - file_name - url - expires_at properties: media_id: type: string format: uuid file_name: type: string mime: type: string size_bytes: type: integer format: int64 url: description: O download, assinado e com prazo curto. type: string expires_at: type: string format: date-time 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' 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. ````