> ## 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. # 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.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: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth 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. 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' duration_seconds: type: integer course_public_id: type: string module_title: type: string previous_public_id: type: string next_public_id: type: string 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 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 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 LessonProgress: type: object required: - completed - last_position_seconds properties: completed: type: boolean completed_at: type: string format: date-time last_position_seconds: type: integer MediaKind: description: Rótulo de tela — o ícone e o filtro. Nada de acesso lê isto. type: string enum: - video - audio - image - document 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ó. type: string enum: - bunny_stream - r2 - youtube - vimeo - external 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. ```` ## Related topics - [Criar aula](/api-reference/content/lessons-create.md) - [Alterar aula](/api-reference/content/lessons-update.md) - [Liberação de conteúdo](/essentials/release.md) - [Weve DRM](/essentials/watermark.md) - [Reordenar o curso](/api-reference/content/course-structure.md)