> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar aula

> A porta pública: precede a view do painel no MRO para trocar autenticação e escopo.

#### Escopo

```bash theme={null}
    read members
```


## OpenAPI

````yaml GET /public_api/members/lessons/{id}/
openapi: 3.0.3
info:
  title: Cakto API
  version: 1.0.0
  description: Documentação da API pública do Cakto.
servers:
  - url: https://api.cakto.com.br
    description: Cakto API
security: []
paths:
  /public_api/members/lessons/{id}/:
    get:
      tags:
        - members
      summary: Consultar aula
      description: >-
        A porta pública: precede a view do painel no MRO para trocar
        autenticação e escopo.
      operationId: members_lessons_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberModuleLessons'
          description: ''
        '401':
          description: Request não autenticado devido à ausência ou invalidez do token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                Token ausente ou inválido:
                  $ref: '#/components/examples/UnauthenticatedErrorExample'
        '404':
          description: Não existe ou não é da sua conta.
      security:
        - OAuth Token: []
components:
  schemas:
    MemberModuleLessons:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Identificador único da aula no sistema
        member_area_module:
          type: string
          format: uuid
          description: Módulo da área de membros ao qual esta aula pertence
          readOnly: true
          title: Módulo da Área de Membros
        title:
          type: string
          title: Título
          description: Título da aula
          maxLength: 255
        description:
          type: string
          title: Descrição
          description: Descrição da aula
        status:
          allOf:
            - $ref: '#/components/schemas/StatusA90Enum'
          description: |-
            Status atual da aula

            * `draft` - Rascunho
            * `published` - Publicado
            * `deleted` - Excluído
        position:
          type: integer
          readOnly: true
          title: Posição
          description: Posição da aula no módulo, para ordenação
        release_type:
          allOf:
            - $ref: '#/components/schemas/ReleaseTypeEnum'
          title: Tipo de liberação
          description: >-
            Como a aula é liberada para o aluno: imediata, dias após a liberação
            do acesso ou data fixa


            * `immediate` - Imediata

            * `after_days` - Dias após a liberação do acesso

            * `fixed_date` - Data fixa
        release_days:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
          title: Dias para liberação
          description: >-
            Dias após a liberação do acesso do aluno, apenas quando o tipo de
            liberação é after_days
        release_date:
          type: string
          format: date-time
          nullable: true
          title: Data de liberação
          description: >-
            Data de liberação da aula, apenas quando o tipo de liberação é
            fixed_date
        is_free:
          type: boolean
          title: Aula gratuita
          description: >-
            Indica se a aula abre a todo membro da área, inclusive o gratuito,
            mesmo dentro de uma seção travada
        thumbnail:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Thumbnail da aula
        thumbnail_original:
          type: string
          format: uri
          readOnly: true
          nullable: true
          description: Thumbnail da aula antes do corte, base para novos cortes
        video:
          allOf:
            - $ref: '#/components/schemas/LessonVideo'
          readOnly: true
        video_id:
          type: string
          writeOnly: true
          nullable: true
        external_video:
          type: string
          readOnly: true
        external_video_url:
          type: string
          writeOnly: true
          nullable: true
          maxLength: 2048
        extra_files_count:
          type: integer
          readOnly: true
        published_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          title: Publicado em
          description: Data de publicação da aula
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Atualizado em
          description: Data de atualização da aula
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Criado em
          description: Data de criação da aula
      required:
        - created_at
        - external_video
        - extra_files_count
        - id
        - member_area_module
        - position
        - published_at
        - thumbnail
        - thumbnail_original
        - title
        - updated_at
        - video
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    StatusA90Enum:
      enum:
        - draft
        - published
        - deleted
      type: string
      description: |-
        * `draft` - Rascunho
        * `published` - Publicado
        * `deleted` - Excluído
    ReleaseTypeEnum:
      enum:
        - immediate
        - after_days
        - fixed_date
      type: string
      description: |-
        * `immediate` - Imediata
        * `after_days` - Dias após a liberação do acesso
        * `fixed_date` - Data fixa
    LessonVideo:
      type: object
      description: Lean read-only representation of a Video nested inside a lesson.
      properties:
        id:
          type: string
          readOnly: true
          description: >-
            Identificador único do vídeo, gerado pelo serviço de armazenamento
            de vídeos (Bunny)
        status:
          allOf:
            - $ref: '#/components/schemas/StatusD3fEnum'
          description: >-
            Status do vídeo no processo de upload e processamento, gerado pelo
            serviço de armazenamento de vídeos (Bunny)


            * `created` - Criado.

            * `queued` - Na fila para codificação.

            * `processing` - Processando.

            * `encoding` - Codificando.

            * `finished` - Finalizado.

            * `videoPlayable` - Video reprodutível. A codificação terminou em
            pelo menos uma resolução.

            * `encodingFailed` - Falha na codificação.

            * `uploadStarted` - Upload iniciado.

            * `uploadFinished` - Upload finalizado.

            * `uploadFailed` - Falha no upload.

            * `captionsGenerated` - Legendas automáticas geradas.

            * `titleOrDescriptionGenerated` - Geração automática do título ou
            descrição finalizada.
        thumbnail:
          type: string
          readOnly: true
      required:
        - id
        - thumbnail
    StatusD3fEnum:
      enum:
        - created
        - queued
        - processing
        - encoding
        - finished
        - videoPlayable
        - encodingFailed
        - uploadStarted
        - uploadFinished
        - uploadFailed
        - captionsGenerated
        - titleOrDescriptionGenerated
      type: string
      description: >-
        * `created` - Criado.

        * `queued` - Na fila para codificação.

        * `processing` - Processando.

        * `encoding` - Codificando.

        * `finished` - Finalizado.

        * `videoPlayable` - Video reprodutível. A codificação terminou em pelo
        menos uma resolução.

        * `encodingFailed` - Falha na codificação.

        * `uploadStarted` - Upload iniciado.

        * `uploadFinished` - Upload finalizado.

        * `uploadFailed` - Falha no upload.

        * `captionsGenerated` - Legendas automáticas geradas.

        * `titleOrDescriptionGenerated` - Geração automática do título ou
        descrição finalizada.
  examples:
    UnauthenticatedErrorExample:
      summary: Token ausente ou inválido
      description: Token ausente ou inválido
      value:
        detail: As credenciais de autenticação não foram fornecidas.
  securitySchemes:
    OAuth Token:
      type: http
      scheme: bearer
      in: header
      name: Authorization
      description: >-
        Token de autenticação do tipo `Bearer {access_token}`, onde
        `{access_token}` é o token obtido no fluxo de
        [autenticação](/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.