> ## 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. # Registra uma mídia > Três caminhos, e a resposta diz qual foi: - **vídeo** (`kind: video` sem `provider`): a Bunny cria o vídeo e a resposta traz `upload` com `method: tus`. - **arquivo** (`kind: image`, `audio` ou `document`): a resposta traz `upload` com `method: put` — um endereço do R2 assinado, que o browser usa num `PUT` direto. Depois do envio, chame `POST /media/{mediaId}/complete`. - **referência de fora** (`provider: youtube`, `vimeo` ou `external`): nada sobe, e a mídia já nasce pronta. - **SafeVideo** (`provider: safevideo`): o vídeo escolhido no launcher do SafeVideo, pela chave dele em `external_id` e a miniatura em `thumbnail_url`. Nasce pronto, como a referência de fora, e exige a extensão ligada (409 `extension_disabled`) — ver `GET /v1/clubs/{clubId}/extensions`. Nos dois envios a chave da conta NUNCA sai daqui: o que viaja é uma assinatura, que vale para um arquivo só e por pouco tempo. `file_name` é o nome original, e é dele que sai a chave do objeto. Com o espaço do club esgotado (`limit_bytes` em `GET /media/storage`), o envio é 409 `storage_full` e nada é criado. A referência de fora não ocupa espaço e passa. Exige permissão de administração do club, e o provedor configurado — sem ele, 501. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/media 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}/media: parameters: - $ref: '#/components/parameters/OrgId' post: tags: - media summary: Registra uma mídia description: | Três caminhos, e a resposta diz qual foi: - **vídeo** (`kind: video` sem `provider`): a Bunny cria o vídeo e a resposta traz `upload` com `method: tus`. - **arquivo** (`kind: image`, `audio` ou `document`): a resposta traz `upload` com `method: put` — um endereço do R2 assinado, que o browser usa num `PUT` direto. Depois do envio, chame `POST /media/{mediaId}/complete`. - **referência de fora** (`provider: youtube`, `vimeo` ou `external`): nada sobe, e a mídia já nasce pronta. - **SafeVideo** (`provider: safevideo`): o vídeo escolhido no launcher do SafeVideo, pela chave dele em `external_id` e a miniatura em `thumbnail_url`. Nasce pronto, como a referência de fora, e exige a extensão ligada (409 `extension_disabled`) — ver `GET /v1/clubs/{clubId}/extensions`. Nos dois envios a chave da conta NUNCA sai daqui: o que viaja é uma assinatura, que vale para um arquivo só e por pouco tempo. `file_name` é o nome original, e é dele que sai a chave do objeto. Com o espaço do club esgotado (`limit_bytes` em `GET /media/storage`), o envio é 409 `storage_full` e nada é criado. A referência de fora não ocupa espaço e passa. Exige permissão de administração do club, e o provedor configurado — sem ele, 501. operationId: createMedia requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MediaCreate' responses: '201': description: Mídia registrada content: application/json: schema: $ref: '#/components/schemas/MediaUploadResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '501': $ref: '#/components/responses/NotConfigured' 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 schemas: MediaCreate: type: object required: - title properties: title: type: string minLength: 1 maxLength: 200 kind: $ref: '#/components/schemas/MediaKind' provider: $ref: '#/components/schemas/MediaProvider' description: | Ausente significa "hospede você": a resposta traz a assinatura de envio, na Bunny para vídeo e no R2 para arquivo. visibility: $ref: '#/components/schemas/MediaVisibility' description: | Ausente é `private`. `public` manda o arquivo para o bucket com domínio próprio, de onde ele é entregue sem assinatura. file_name: description: | O nome do arquivo que vai ser enviado. Dele sai a chave do objeto, e é ele que o navegador mostra quando o aluno salva o material. type: string maxLength: 255 mime: type: string maxLength: 255 external_id: description: | O vídeo no YouTube ou no Vimeo, ou a URL em `external`. Para `youtube` e `vimeo` vale o LINK da barra de endereços ou o id cru: a API normaliza os dois para o mesmo id canônico, que é o que a resposta devolve e o que a tela usa para montar o player. O que não for vídeo daquele provedor é 422 `invalid_external_id`. Em `external` o valor é guardado como veio. Em `safevideo` é a chave do vídeo que o launcher do SafeVideo devolve. type: string maxLength: 2000 thumbnail_url: description: | A miniatura do vídeo do SafeVideo, como o launcher a devolve — endereço `https`. Só vale para `provider: safevideo`; nos outros é ignorada, porque a miniatura sai do próprio provedor. type: string maxLength: 2000 folder_id: type: string format: uuid MediaUploadResponse: type: object required: - data properties: data: $ref: '#/components/schemas/Media' upload: $ref: '#/components/schemas/MediaUpload' 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ó. `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 MediaVisibility: description: | `private` é o padrão, e continua sendo depois de qualquer dúvida: publicar é escolha explícita. A diferença é de BUCKET, não de um sinalizador na hora de entregar — objeto privado não tem endereço público, então nenhum erro de código consegue publicá-lo. Privado é entregue por endereço assinado e de prazo curto; público, por um endereço estável que o CDN cacheia. Público existe para o que precisa ser visto por quem ainda não comprou e sobreviver a um cache: a capa do curso na vitrine, a marca do club, o trailer. Uma URL assinada não serve para isso — ela muda a cada resposta, então o CDN nunca acerta, a prévia de link do WhatsApp busca a imagem dias depois e a capa dentro de um e-mail vence. type: string enum: - private - public Media: type: object required: - id - kind - title - provider - status - visibility - archived - created_at properties: id: type: string format: uuid kind: $ref: '#/components/schemas/MediaKind' title: type: string file_name: type: string mime: type: string size_bytes: type: integer format: int64 provider: $ref: '#/components/schemas/MediaProvider' external_id: description: | O id no provedor de FORA (o vídeo do YouTube, a URL colada). Para o que hospedamos, o id não vai na resposta: o que a tela precisa é o `preview_url` assinado. type: string status: $ref: '#/components/schemas/MediaStatus' visibility: $ref: '#/components/schemas/MediaVisibility' error: type: string duration_seconds: type: integer width: type: integer height: type: integer preview_url: description: | Endereço assinado e de prazo curto, para a tela do admin ver o que é este arquivo. Não é guardado em lugar nenhum — expira. type: string thumbnail_url: description: A miniatura, assinada pelo mesmo prazo curto. type: string folder_id: type: string format: uuid archived: type: boolean created_at: type: string format: date-time type: $ref: '#/components/schemas/MediaScreenType' download_url: description: | Endereço assinado e de prazo curto do arquivo — o `preview_url` abre na aba. No arquivo hospedado, baixa com o nome original; no vídeo hospedado, é o MP4 em 720p. Referência de fora não tem download. type: string expires_at: description: | A gravação de live ou de encontro sem a Hospedagem de vídeo sai nesta data — baixe antes (`download_url`) ou contrate a Hospedagem, e ela fica. Ausente é mídia que não vence. type: string format: date-time favorite: description: | Se QUEM PEDE favoritou. Vem na lista, na leitura de uma e nas edições da biblioteca; ausente nas outras respostas. type: boolean usage_count: description: | Em quantos lugares a mídia é usada — o "usado em 3 lugares" da tela. A lista é `GET /media/{mediaId}/usage`. Vem na lista, na leitura de uma e nas edições da biblioteca. type: integer MediaUpload: description: | O que o browser precisa para enviar o arquivo sozinho. O endereço e os cabeçalhos levam uma ASSINATURA — nunca a chave da conta —, valem para esta mídia e expiram. `tus` é o envio em pedaços do vídeo (a Bunny retoma de onde parou); `put` é um envio único para o R2, e depois dele vem `POST /media/{mediaId}/complete`. type: object required: - method - url - headers - expires_at properties: method: type: string enum: - tus - put url: type: string headers: type: object additionalProperties: type: string expires_at: type: string format: date-time 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 MediaStatus: description: | `uploading` enquanto o arquivo não chegou, `processing` enquanto o provedor transcodifica, `ready` quando dá para entregar, `failed` quando o provedor desistiu (e aí `error` diz por quê). type: string enum: - uploading - processing - ready - failed MediaScreenType: description: | O tipo como a TELA o mostra: o `kind`, com `document` separado em `pdf` e `file` (o zip, a planilha, o resto), e `embed` para a referência de fora (`youtube`, `vimeo`, `external`), qualquer que seja o `kind`. É derivado do provedor, do `kind`, do tipo do arquivo e da extensão, e é o mesmo que o filtro `types` usa. type: string enum: - video - image - audio - pdf - file - embed responses: BadRequest: description: Requisição malformada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' PaymentRequired: description: > O plano do club não cobre o pedido. `feature_not_in_plan` é o club não ter o recurso (falta contratar); `limit_reached` é a franquia de um recurso que não cobra excedente ter acabado. A `message` diz de qual recurso se trata. `payment_failed` é o cartão recusado ao contratar um adicional. Nas rotas de quem NÃO administra o club (cadastro, conversa com o agente) o `code` é o mesmo, e a `message` é dita a essa pessoa — sem falar do plano, que é conversa do club com a weve. 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' Conflict: description: >- Conflito com o estado atual. O `code` diz qual; a descrição da operação lista os possíveis. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos 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' NotConfigured: description: | O ambiente não tem o que a operação precisa (`not_configured`): o provedor de autenticação nas rotas de sessão, o e-mail nas que enviam link, a chave de cifra nos webhooks. 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. ````