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

# Configurar o assistente do curso

> Liga, desliga e dá nome e tom de voz ao assistente das aulas.

Ligado, as aulas publicadas do curso entram na fila de leitura e o **Perguntar** aparece para
quem pode assistir a elas. Desligado, o botão some; as conversas continuam legíveis pela equipe
em [Listar conversas](/api-reference/agents/conversations-list), com o id do curso como `agentId`.

Com `comment_replies`, ele também responde sozinho, em público, o comentário de aluno que abre
uma conversa nas aulas — no club que modera, depois da aprovação. Cada resposta escrita conta nas
respostas automáticas do plano.


## OpenAPI

````yaml PUT /v1/clubs/{clubId}/courses/{courseId}/assistant
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
  - name: exports
  - name: certificates
paths:
  /v1/clubs/{clubId}/courses/{courseId}/assistant:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/CourseId'
    put:
      tags:
        - agents
      summary: Configura o assistente do curso
      description: >
        Liga ou desliga o assistente e define a voz dele. O corpo é o estado

        INTEIRO. Ligar vale a partir de agora: as aulas do curso entram na fila

        de leitura (e os vídeos, na de transcrição) na primeira vez, e o

        "Perguntar" aparece para quem pode assistir às aulas — sem comprar nada

        além do curso. O gasto é contido pelos tetos de sempre: o

        `daily_message_limit` por pessoa, o orçamento de IA do club e as

        mensagens do plano.


        Desligar some com o "Perguntar" e cala a resposta nos comentários; as

        conversas continuam, e a equipe continua lendo.


        `instructions` vazio deixa só o comportamento padrão da plataforma: ele

        responde a partir das aulas, em português e de forma direta, sem um tom

        próprio.


        `comment_replies` liga a resposta AUTOMÁTICA nos comentários das aulas:

        o comentário que abre a conversa, de aluno, é respondido em público

        pelo assistente, nos segundos seguintes — ou depois da aprovação, no

        club que modera. Ele cala quando o material não cobre a pergunta. Como a

        resposta fica à vista de todos, em curso com liberação escalonada ela

        pode tocar em aulas que alguém ainda não alcançou. Cada resposta escrita

        conta nas respostas automáticas do plano (`support_responses`).


        Exige permissão de administração do club.


        Os dois interruptores passam pelo plano só ao LIGAR — regravar o nome

        com o assistente já ligado não esbarra num plano que mudou depois.


        Erros: `feature_not_in_plan` (402, ligar sem o adicional de agentes no

        plano, ou ligar `comment_replies` sem o de respostas automáticas);

        `assistant_not_enabled` (403, `comment_replies` num club de antes dos

        planos sem o recurso liberado); `missing_field` (422, `name` em branco);
        `name_too_long` (422);

        `invalid_field` (422, `instructions` acima do teto ou

        `daily_message_limit` fora de 1 a 1000).
      operationId: setCourseAssistant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CourseAssistantInput'
      responses:
        '200':
          description: O assistente gravado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseAssistantResponse'
        '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'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '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
    CourseId:
      name: courseId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    CourseAssistantInput:
      type: object
      additionalProperties: false
      required:
        - enabled
        - name
        - instructions
        - daily_message_limit
        - comment_replies
      properties:
        enabled:
          type: boolean
        comment_replies:
          type: boolean
        name:
          type: string
          minLength: 1
          maxLength: 80
        instructions:
          type: string
          maxLength: 20000
        daily_message_limit:
          type: integer
          minimum: 1
          maximum: 1000
    CourseAssistantResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/CourseAssistant'
    CourseAssistant:
      description: |
        O assistente de um curso. `enabled` é o que decide se ele responde; os
        demais campos valem mesmo desligado, para ligar de novo sem reescrever.
      type: object
      required:
        - enabled
        - name
        - instructions
        - daily_message_limit
        - comment_replies
        - conversation_count
      properties:
        enabled:
          type: boolean
        comment_replies:
          type: boolean
          description: |
            Se ele responde SOZINHO, embaixo do comentário, quem comenta nas
            aulas. Vale só com `enabled`, e só para o comentário que abre a
            conversa, de aluno.
        name:
          type: string
          description: Como o aluno o vê no "Perguntar" e nos comentários.
        instructions:
          type: string
          description: >-
            O tom de voz e o que ele deve ou não fazer. Vazio usa o padrão da
            plataforma.
        daily_message_limit:
          type: integer
          description: Quantas perguntas uma pessoa faz a ele em 24 horas corridas.
        conversation_count:
          type: integer
          description: |
            Quantas conversas os alunos já tiveram com ele, ligado ou não — elas
            continuam legíveis depois de desligado.
    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
  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'
    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'
  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

- [Configurar o certificado do curso](/api-reference/certificates/course-set.md)
- [Ver o assistente do curso](/api-reference/agents/course-assistant-get.md)
- [Responder com o assistente](/api-reference/comments/managed-assistant-reply.md)
- [Agentes](/essentials/agents.md)
- [Listar cursos](/api-reference/content/courses-list.md)