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

# Obter Agente

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

<ParamField path="id" type="uuid">
  ID do agente
</ParamField>

## Descrição da Resposta

Abaixo você verá a descrição da resposta do agente

<ResponseField name="id" type="string" required>
  Identificador único do agente.
</ResponseField>

<ResponseField name="name" type="string" required>
  Nome do agente.
</ResponseField>

<ResponseField name="prompt" type="string">
  Prompt principal utilizado pelo agente.
</ResponseField>

<ResponseField name="metaprompt" type="string">
  Metaprompt com instruções avançadas de comportamento, linguagem e formatação.
</ResponseField>

<ResponseField name="description" type="string">
  Descrição do agente.
</ResponseField>

<ResponseField name="folders" type="array">
  Lista de pastas associadas ao agente.
</ResponseField>

<ResponseField name="plugins" type="array">
  Lista de plugins associados ao agente.
</ResponseField>

<ResponseField name="botGenAI" type="array">
  Configurações de IA generativa associadas ao agente.

  <Expandable title="BotGenAI properties">
    <ResponseField name="isDefault" type="boolean" required>
      Indica se esta é a configuração padrão do agente.
    </ResponseField>

    <ResponseField name="messagesLimit" type="number">
      Limite máximo de mensagens.
    </ResponseField>

    <ResponseField name="charactersLimit" type="number">
      Limite máximo de caracteres.
    </ResponseField>

    <ResponseField name="temperature" type="number">
      Controla o nível de criatividade das respostas.
    </ResponseField>

    <ResponseField name="topP" type="number">
      Define o recorte probabilístico das respostas geradas.
    </ResponseField>

    <ResponseField name="frequencyPenalty" type="number">
      Penalidade aplicada para reduzir repetições nas respostas.
    </ResponseField>

    <ResponseField name="presencePenalty" type="number">
      Penalidade aplicada para incentivar novos tópicos nas respostas.
    </ResponseField>

    <ResponseField name="topK" type="number">
      Limita a quantidade de tokens candidatos considerados na geração.
    </ResponseField>

    <ResponseField name="messagesQuery" type="number">
      Quantidade de mensagens utilizadas como contexto.
    </ResponseField>

    <ResponseField name="id" type="string" required>
      Identificador da configuração de IA generativa.
    </ResponseField>

    <ResponseField name="botId" type="string" required>
      Identificador do agente associado.
    </ResponseField>

    <ResponseField name="genAIId" type="string">
      Identificador do provedor de IA generativa.
    </ResponseField>

    <ResponseField name="genAIKey" type="string">
      Chave do provedor de IA generativa.
    </ResponseField>

    <ResponseField name="genAIOrganization" type="string">
      Organização associada ao provedor de IA generativa.
    </ResponseField>

    <ResponseField name="genAIModelId" type="string">
      Identificador do modelo de IA generativa.
    </ResponseField>

    <ResponseField name="assistantId" type="string">
      Identificador do assistente externo vinculado.
    </ResponseField>

    <ResponseField name="credentialId" type="string">
      Identificador da credencial principal.
    </ResponseField>

    <ResponseField name="analyticsCredentialId" type="string">
      Identificador da credencial de analytics.
    </ResponseField>

    <ResponseField name="model" type="string">
      Modelo utilizado pelo agente.
    </ResponseField>

    <ResponseField name="tools" type="array">
      Ferramentas associadas à configuração.
    </ResponseField>

    <ResponseField name="whatsappCredentialId" type="string">
      Identificador da credencial do WhatsApp.
    </ResponseField>

    <ResponseField name="instagramCredentialId" type="string">
      Identificador da credencial do Instagram.
    </ResponseField>

    <ResponseField name="messengerCredentialId" type="string">
      Identificador da credencial do Messenger.
    </ResponseField>

    <ResponseField name="messengerCredential" type="object">
      Informações da credencial do Messenger.

      <Expandable title="Messenger credential properties">
        <ResponseField name="integration" type="object">
          Integração associada à credencial do Messenger.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="genAIModel" type="object">
      Dados do modelo de IA generativa.
    </ResponseField>

    <ResponseField name="genAI" type="object">
      Dados do provedor de IA generativa.
    </ResponseField>

    <ResponseField name="instagramCredential" type="object">
      Informações da credencial do Instagram.

      <Expandable title="Instagram credential properties">
        <ResponseField name="integration" type="object">
          Integração associada à credencial do Instagram.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="analyticsCredential" type="object">
      Informações da credencial de analytics.

      <Expandable title="Analytics credential properties">
        <ResponseField name="integration" type="object">
          Integração associada à credencial de analytics.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="whatsappCredential" type="object">
      Informações da credencial do WhatsApp.

      <Expandable title="Whatsapp credential properties">
        <ResponseField name="integration" type="object">
          Integração associada à credencial do WhatsApp.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="credential" type="object">
      Credencial principal utilizada pelo agente.

      <Expandable title="Credential properties">
        <ResponseField name="status" type="boolean" required>
          Indica se a credencial está ativa.
        </ResponseField>

        <ResponseField name="id" type="string" required>
          Identificador da credencial.
        </ResponseField>

        <ResponseField name="name" type="string" required>
          Nome da credencial.
        </ResponseField>

        <ResponseField name="userId" type="string" required>
          Identificador do usuário associado à credencial.
        </ResponseField>

        <ResponseField name="unityId" type="string" required>
          Identificador da unidade associada à credencial.
        </ResponseField>

        <ResponseField name="integrationId" type="string" required>
          Identificador da integração da credencial.
        </ResponseField>

        <ResponseField name="secretId" type="string" required>
          Identificador secreto da credencial.
        </ResponseField>

        <ResponseField name="createdAt" type="string" required>
          Data de criação da credencial.
        </ResponseField>

        <ResponseField name="updatedAt" type="string">
          Data da última atualização da credencial.
        </ResponseField>

        <ResponseField name="virtualKey" type="string">
          Chave virtual associada à credencial.
        </ResponseField>

        <ResponseField name="integration" type="object">
          Integração associada à credencial.

          <Expandable title="Integration properties">
            <ResponseField name="status" type="boolean" required>
              Indica se a integração está ativa.
            </ResponseField>

            <ResponseField name="id" type="string" required>
              Identificador da integração.
            </ResponseField>

            <ResponseField name="name" type="string" required>
              Nome da integração.
            </ResponseField>

            <ResponseField name="type" type="string" required>
              Tipo da integração.
            </ResponseField>

            <ResponseField name="form" type="array">
              Campos de formulário necessários para a integração.

              <Expandable title="Form properties">
                <ResponseField name="name" type="string" required>
                  Nome do campo.
                </ResponseField>

                <ResponseField name="type" type="string" required>
                  Tipo do campo.
                </ResponseField>

                <ResponseField name="label" type="string" required>
                  Rótulo do campo.
                </ResponseField>

                <ResponseField name="maxLenght" type="string">
                  Tamanho máximo permitido para o campo.
                </ResponseField>

                <ResponseField name="required" type="boolean" required>
                  Indica se o campo é obrigatório.
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="createdAt" type="string" required>
              Data de criação da integração.
            </ResponseField>

            <ResponseField name="updatedAt" type="string">
              Data da última atualização da integração.
            </ResponseField>

            <ResponseField name="iconId" type="string">
              Identificador do ícone da integração.
            </ResponseField>

            <ResponseField name="validationEndpoint" type="string">
              Endpoint de validação da integração.
            </ResponseField>

            <ResponseField name="slug" type="string">
              Slug da integração.
            </ResponseField>

            <ResponseField name="icon" type="object">
              Ícone associado à integração.

              <Expandable title="Icon properties">
                <ResponseField name="id" type="string" required>
                  Identificador do ícone.
                </ResponseField>

                <ResponseField name="institutionId" type="string" required>
                  Identificador da instituição associada ao ícone.
                </ResponseField>

                <ResponseField name="type" type="string" required>
                  Tipo do ícone.
                </ResponseField>

                <ResponseField name="fileName" type="string" required>
                  Nome do arquivo do ícone.
                </ResponseField>

                <ResponseField name="internalStorageUrl" type="string" required>
                  URL interna do armazenamento do ícone.
                </ResponseField>

                <ResponseField name="url" type="string" required>
                  URL pública do ícone.
                </ResponseField>

                <ResponseField name="maskName" type="string" required>
                  Nome mascarado do arquivo.
                </ResponseField>

                <ResponseField name="createdAt" type="string" required>
                  Data de criação do ícone.
                </ResponseField>

                <ResponseField name="updatedAt" type="string">
                  Data da última atualização do ícone.
                </ResponseField>

                <ResponseField name="extension" type="string">
                  Extensão do arquivo.
                </ResponseField>

                <ResponseField name="size" type="number">
                  Tamanho do arquivo em bytes.
                </ResponseField>

                <ResponseField name="numberWords" type="number">
                  Quantidade de palavras associadas ao recurso, quando aplicável.
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="assistantId" type="string">
  Identificador do assistente externo associado ao agente.
</ResponseField>

<ResponseField name="IconFile" type="object">
  Arquivo de ícone associado ao agente.
</ResponseField>

<ResponseField name="tags" type="array">
  Lista de tags associadas ao agente.
</ResponseField>

<ResponseField name="unityId" type="string" required>
  Identificador da unidade associada ao agente.
</ResponseField>

<ResponseField name="progressStatus" type="string">
  Status de progresso do agente.
</ResponseField>

<ResponseField name="safeMode" type="boolean">
  Indica se o modo seguro está habilitado.
</ResponseField>

<ResponseField name="institutionId" type="string">
  Identificador da instituição associada.
</ResponseField>

<ResponseField name="isActivated" type="boolean">
  Indica se o agente está ativado.
</ResponseField>

<ResponseField name="botMonetization" type="object">
  Configurações de monetização do agente.
</ResponseField>

<ResponseField name="hasMonetization" type="boolean">
  Indica se o agente possui monetização habilitada.
</ResponseField>

<ResponseField name="hasAnalytics" type="boolean">
  Indica se o agente possui analytics habilitado.
</ResponseField>

<ResponseField name="hasMulti" type="boolean">
  Indica se o agente possui suporte multicanal.
</ResponseField>

<ResponseField name="isAdvancedBot" type="boolean">
  Indica se o agente utiliza configurações avançadas.
</ResponseField>

<ResponseField name="hasTools" type="boolean">
  Indica se o agente possui ferramentas habilitadas.
</ResponseField>

<ResponseField name="hasVoice" type="boolean">
  Indica se o agente possui recurso de voz habilitado.
</ResponseField>

<ResponseField name="botVoiceConfig" type="array">
  Lista de configurações de voz do agente.
</ResponseField>

<ResponseField name="hasPlugins" type="boolean">
  Indica se o agente possui plugins habilitados.
</ResponseField>

<ResponseField name="hasWhatsapp" type="boolean">
  Indica se o agente possui integração com WhatsApp.
</ResponseField>

<ResponseField name="hasInstagram" type="boolean">
  Indica se o agente possui integração com Instagram.
</ResponseField>

<ResponseField name="hasMessenger" type="boolean">
  Indica se o agente possui integração com Messenger.
</ResponseField>

<ResponseField name="botMultiAgents" type="array">
  Lista de com ID de agente associados ao multiagente se habilitado.
</ResponseField>

<ResponseField name="favorites" type="array">
  Lista de favoritos associados ao agente.
</ResponseField>

<ResponseField name="botFallBack" type="array">
  Lista de configurações de fallback do agente.
</ResponseField>
