> ## 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. # Sessão do aluno > Com o resumo e os arquivos. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/classroom/mentorships/{publicId}/sessions/{sessionId} 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 paths: /v1/clubs/{clubId}/classroom/mentorships/{publicId}/sessions/{sessionId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/PublicId' - $ref: '#/components/parameters/MentorshipSessionId' get: tags: - mentorships summary: Uma sessão do aluno, com o resumo e os arquivos description: >- Só sessão de que a pessoa participa ou participou; a de outra pessoa é 404. operationId: getClassroomMentorshipSession responses: '200': description: A sessão content: application/json: schema: $ref: '#/components/schemas/ClassroomMentorshipSessionResponse' '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 MentorshipSessionId: name: sessionId in: path required: true schema: type: string format: uuid schemas: ClassroomMentorshipSessionResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClassroomMentorshipSession' ClassroomMentorshipSession: type: object required: - id - format - status - attendance - starts_at - ends_at - mentor_name - meeting - capacity - attendees_count - rated - can_cancel - cancel_consumes_credit properties: id: type: string format: uuid format: $ref: '#/components/schemas/MentorshipSessionFormat' title: type: string status: $ref: '#/components/schemas/MentorshipSessionStatus' attendance: $ref: '#/components/schemas/MentorshipAttendance' starts_at: type: string format: date-time ends_at: type: string format: date-time mentor_name: type: string meeting: $ref: '#/components/schemas/MentorshipMeeting' meeting_url: type: string description: Só enquanto a inscrição está de pé, e só quando `meeting` é `link`. room_opens_at: description: Na sala nossa, quando `join` passa a abrir a sala. type: string format: date-time room_closes_at: type: string format: date-time recorded: description: O encontro é gravado — a tela avisa quem entra. type: boolean summary: type: string agenda: type: string capacity: type: integer attendees_count: type: integer rated: type: boolean can_cancel: type: boolean cancel_consumes_credit: type: boolean description: Desmarcar AGORA consome o crédito. files: description: Só na leitura de uma sessão. type: array items: $ref: '#/components/schemas/MentorshipFile' 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 MentorshipSessionFormat: type: string enum: - individual - group x-enum-varnames: - SessionFormatIndividual - SessionFormatGroup MentorshipSessionStatus: type: string enum: - upcoming - in_progress - ended - cancelled x-enum-varnames: - SessionUpcoming - SessionInProgress - SessionEnded - SessionCancelled description: | Derivado do relógio, não gravado: `ended` é ter passado de `ends_at` sem cancelamento. Não há "concluir" a clicar. MentorshipAttendance: type: string enum: - booked - attended - no_show - cancelled - cancelled_late x-enum-varnames: - AttendanceBooked - AttendanceAttended - AttendanceNoShow - AttendanceCancelled - AttendanceCancelledLate description: | O que aconteceu com a PESSOA na sessão. `booked` é inscrita numa sessão que ainda não terminou; `attended`, inscrita numa que terminou sem falta marcada; `cancelled_late`, desmarcou dentro do prazo de aviso e consumiu o crédito. Sessão cancelada pela equipe aparece como `cancelled`. MentorshipMeeting: description: | Onde o encontro acontece: `room` é a sala nossa (entra-se por `join`); `link` é o endereço de fora em `meeting_url`. type: string enum: - room - link x-enum-varnames: - MeetingRoom - MeetingLink MentorshipFile: type: object required: - media_id - title - kind - ready properties: media_id: type: string format: uuid title: type: string kind: $ref: '#/components/schemas/MediaKind' ready: type: boolean description: >- Falso enquanto o envio ou o processamento não terminou — e aí não há `playback`. playback: $ref: '#/components/schemas/Playback' MediaKind: description: Rótulo de tela — o ícone e o filtro. Nada de acesso lê isto. type: string enum: - video - audio - image - document 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 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 - [Sessão do aluno](/api-reference/auth/session.md) - [Encerrar sessão](/api-reference/auth/sign-out.md) - [Entrar com o código](/api-reference/auth/login-code-exchange.md) - [Entrar no classroom](/api-reference/auth/sign-in.md) - [Mentoria do aluno](/api-reference/mentorships/classroom-get.md)