> ## 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. # Editar live > Edita, remarca, publica ou cancela. ## OpenAPI ````yaml PATCH /v1/clubs/{clubId}/lives/{liveId} 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}/lives/{liveId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/LiveId' patch: tags: - lives summary: Edita, remarca, publica ou cancela description: > Só o que vier no corpo muda. Remarcar rearma os lembretes para a hora nova — quem já recebeu o lembrete da hora antiga recebe o da nova. Depois de a transmissão começar, horário e provedor não mudam mais (409 `live_started`). `cancelled: true` cancela: a live some da agenda de quem assiste e nenhum aviso pendente sai. Live que aconteceu não se cancela (409 `live_started`), e cancelada não volta (409 `live_cancelled`). `replay_media_id` troca o que o aluno assiste depois — qualquer vídeo da biblioteca. Exige administrar o club. operationId: updateLive requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LiveUpdate' responses: '200': description: A live content: application/json: schema: $ref: '#/components/schemas/LiveDetailResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '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 LiveId: name: liveId in: path required: true schema: type: string format: uuid schemas: LiveUpdate: type: object additionalProperties: false properties: title: type: string minLength: 1 maxLength: 160 description: type: string maxLength: 4000 nullable: true cover_media_id: type: string format: uuid nullable: true provider: $ref: '#/components/schemas/LiveProvider' source_url: type: string maxLength: 500 nullable: true starts_at: type: string format: date-time duration_minutes: type: integer minimum: 15 maximum: 720 chat_enabled: type: boolean record: type: boolean published_at: type: string format: date-time nullable: true replay_media_id: description: Um vídeo da biblioteca; nulo tira o replay. type: string format: uuid nullable: true cancelled: description: Só `true`; live cancelada não volta. type: boolean cancel_reason: type: string maxLength: 500 LiveDetailResponse: type: object required: - data properties: data: $ref: '#/components/schemas/LiveDetail' LiveProvider: description: > Onde a transmissão acontece. `livekit` é a sala nossa — com palco, chat e gravação —; `youtube` e `vimeo` são tocados por embed no classroom; `link` é qualquer outra sala (Zoom, Meet), aberta fora. type: string enum: - livekit - youtube - vimeo - link x-enum-varnames: - LiveProviderLivekit - LiveProviderYoutube - LiveProviderVimeo - LiveProviderLink LiveDetail: type: object required: - live - speakers - recordings properties: live: $ref: '#/components/schemas/Live' speakers: description: Os alunos no palco agora. type: array items: $ref: '#/components/schemas/LiveSpeaker' recordings: type: array items: $ref: '#/components/schemas/RoomRecording' 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 Live: type: object required: - id - public_id - channel_id - channel_name - title - provider - status - starts_at - ends_at - chat_enabled - record - recording - hosts - viewers - created_at - updated_at properties: id: type: string format: uuid public_id: type: string channel_id: type: string format: uuid channel_name: type: string title: type: string description: type: string cover: $ref: '#/components/schemas/Media' provider: $ref: '#/components/schemas/LiveProvider' source_url: description: > O endereço de fora: o vídeo do YouTube ou do Vimeo, ou o link da sala. Ausente na sala nossa. Só a equipe o vê — o aluno recebe o embed ou o link em `join`, depois de conferido o acesso. type: string status: $ref: '#/components/schemas/LiveStatus' starts_at: type: string format: date-time ends_at: type: string format: date-time chat_enabled: type: boolean record: description: Grava ao começar a transmissão (só na sala nossa). type: boolean recording: description: A sala está sendo gravada agora. type: boolean published_at: type: string format: date-time started_at: type: string format: date-time ended_at: type: string format: date-time cancelled_at: type: string format: date-time cancel_reason: type: string replay: $ref: '#/components/schemas/Media' hosts: description: Quem apresenta além de quem administra o club. type: array items: $ref: '#/components/schemas/LiveHost' viewers: description: >- Quantos alunos entraram, contados pela sala (ou pelo clique, fora dela). type: integer created_at: type: string format: date-time updated_at: type: string format: date-time LiveSpeaker: type: object required: - student_id - name - since properties: student_id: type: string format: uuid name: type: string since: type: string format: date-time RoomRecording: type: object required: - id - status - started_at properties: id: type: string format: uuid status: $ref: '#/components/schemas/RoomRecordingStatus' media: $ref: '#/components/schemas/Media' size_bytes: type: integer format: int64 duration_seconds: type: integer error: type: string started_at: type: string format: date-time ended_at: type: string format: date-time 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 LiveStatus: description: > DERIVADO, nunca gravado. `scheduled`: o horário ainda não chegou. `waiting` (só na sala nossa): o horário chegou e quem apresenta ainda não começou. `live`: na sala nossa, quem apresenta começou e não encerrou; fora dela, dentro do horário. `ended`: encerrada, ou o horário (mais a folga do atraso, na sala nossa) passou. `cancelled`: cancelada. type: string enum: - scheduled - waiting - live - ended - cancelled x-enum-varnames: - LiveStatusScheduled - LiveStatusWaiting - LiveStatusLive - LiveStatusEnded - LiveStatusCancelled LiveHost: type: object required: - user_id - name properties: user_id: type: string format: uuid name: type: string RoomRecordingStatus: description: > `requested`: a gravação foi pedida e a máquina do gravador está ligando (alguns segundos). `recording`: a sala está sendo gravada. `uploaded`: o arquivo chegou e está na fila para virar mídia. `imported`: virou mídia (o estado do vídeo é o da mídia). `failed`: o motivo está em `error`. type: string enum: - requested - recording - uploaded - imported - failed x-enum-varnames: - RecordingStatusRequested - RecordingStatusRecording - RecordingStatusUploaded - RecordingStatusImported - RecordingStatusFailed 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 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 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 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' 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. ```` ## Related topics - [Editar canal](/api-reference/lives/live-channels-update.md) - [Lives](/essentials/lives.md) - [Editar anotação](/api-reference/mentorships/note-update.md) - [Editar meta](/api-reference/mentorships/goal-update.md) - [Editar playbook](/api-reference/mentorships/playbook-update.md)