POST
/
api
/
v1
/
credential
Criar Credencial
curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/credential \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "integrationId": "<string>",
  "status": true
}'
{
  "prompt": "<string>",
  "description": "<string>",
  "folders": [
    "<any>"
  ],
  "plugins": [
    "<any>"
  ],
  "botGenAI": "<any>",
  "assistantId": "<string>",
  "IconFile": "<any>",
  "widgetId": "<string>",
  "tags": [
    "<string>"
  ],
  "unityId": "<string>",
  "progressStatus": "<string>",
  "safeMode": true,
  "institutionId": "<string>",
  "indexService": "<string>",
  "isActivated": true
}

​
Descrição do Body

​
name
string
required
Nome da credencial
​
userId
string
required
ID do usuário
​
unityId
string
required
ID da unidade
​
integrationId
string
required
ID da integração
​
status
boolean
required
Status da credencial

​
Descrição da Resposta

Abaixo você verá a descrição da resposta da credencial
​
prompt
string
required
Texto ou comando usado como entrada para o agente.
​
description
string
required
Descrição detalhada da finalidade ou funcionalidade do agente.
​
folders
any[]
required
Lista de pastas associadas ao agente.
​
plugins
any[]
required
Plugins ou integrações ativas do agente.
​
botGenAI
any
required
Configurações relacionadas à inteligência artificial do agente.
​
assistantId
string
required
ID único do assistente vinculado.
​
IconFile
any
required
Arquivo de ícone associado ao agente.
​
widgetId
string
ID opcional do widget vinculado.
​
tags
string[]
Lista de tags associadas ao agente.
​
unityId
string
ID da unidade organizacional.
​
progressStatus
string
Status de progresso do agente.
​
safeMode
boolean
Indica se o modo seguro está ativado.
​
institutionId
string
required
ID da instituição responsável pelo agente.
​
indexService
string
Serviço de indexação vinculado ao agente.
​
isActivated
boolean
required
Status de ativação do agente.

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