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

# Arquivos do mentorado

> Assinados na hora da resposta.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/mentorships/{mentorshipId}/participants/{studentId}/files
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}/mentorships/{mentorshipId}/participants/{studentId}/files:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/MentorshipId'
      - $ref: '#/components/parameters/StudentId'
    get:
      tags:
        - mentorships
      summary: Os arquivos do mentorado
      operationId: listMentorshipParticipantFiles
      responses:
        '200':
          description: Os arquivos, na ordem, assinados na hora
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentorshipFileList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
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
    MentorshipId:
      name: mentorshipId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    StudentId:
      name: studentId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    MentorshipFileList:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MentorshipFile'
    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'
    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
    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:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Definir arquivos do mentorado](/api-reference/mentorships/participant-files-set.md)
- [Sessões do mentorado](/api-reference/mentorships/participant-sessions.md)
- [Plano do mentorado](/api-reference/mentorships/plan-get.md)
- [Arquivos do aluno](/api-reference/mentorships/classroom-files-list.md)
- [Quadro de mentorados](/api-reference/mentorships/participants-list.md)
