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

# Criar Credencial

> Endpoint para criar uma Credencial

## Token de Acesso

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

## Descrição do Body

<ParamField body="name" type="string" required="true">
  Nome da credencial
</ParamField>

<ParamField body="userId" type="string" required="true">
  ID do usuário
</ParamField>

<ParamField body="unityId" type="string" required="true">
  ID da unidade
</ParamField>

<ParamField body="integrationId" type="string" required="true">
  ID da integração
</ParamField>

<ParamField body="status" type="boolean" required="true">
  Status da credencial
</ParamField>

## Descrição da Resposta

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

<ResponseField name="prompt" type="string" required>
  Texto ou comando usado como entrada para o agente.
</ResponseField>

<ResponseField name="description" type="string" required>
  Descrição detalhada da finalidade ou funcionalidade do agente.
</ResponseField>

<ResponseField name="folders" type="any[]" required>
  Lista de pastas associadas ao agente.
</ResponseField>

<ResponseField name="plugins" type="any[]" required>
  Plugins ou integrações ativas do agente.
</ResponseField>

<ResponseField name="botGenAI" type="any" required>
  Configurações relacionadas à inteligência artificial do agente.
</ResponseField>

<ResponseField name="assistantId" type="string" required>
  ID único do assistente vinculado.
</ResponseField>

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

<ResponseField name="widgetId" type="string">
  ID opcional do widget vinculado.
</ResponseField>

<ResponseField name="tags" type="string[]">
  Lista de tags associadas ao agente.
</ResponseField>

<ResponseField name="unityId" type="string">
  ID da unidade organizacional.
</ResponseField>

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

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

<ResponseField name="institutionId" type="string" required>
  ID da instituição responsável pelo agente.
</ResponseField>

<ResponseField name="indexService" type="string">
  Serviço de indexação vinculado ao agente.
</ResponseField>

<ResponseField name="isActivated" type="boolean" required>
  Status de ativação do agente.
</ResponseField>

### O que é uma Credencial na nossa plataforma?

Uma abordagem abrangente para integrar o agente com uma ampla variedade de serviços e plataformas de terceiros, garantindo comunicação fluida, funcionalidades ampliadas e suporte para diferentes casos de uso.

### Segurança 🔒

Para acessar este endpoint, é necessário enviar uma **api key** válida através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.