Criar Fallback

Endpoint para criar um Fallback

POST /api/v1/bot/configuration/fallback

Criar Fallback

cURL

curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback \
  --header 'Content-Type: application/json' \
  --data '
{
  "botId": "<string>",
  "fallBacks": [
    {}
  ]
}
'

200

{
  "items": [
    {
      "id": "<string>",
      "botId": "<string>",
      "order": 123,
      "credentialId": "<string>",
      "model": "<string>",
      "createdAt": "<string>",
      "credential": {
        "id": "<string>",
        "name": "<string>",
        "userId": "<string>",
        "unityId": "<string>",
        "integrationId": "<string>",
        "secretId": "<string>",
        "status": true,
        "virtualKey": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "integration": {
          "id": "<string>",
          "name": "<string>",
          "iconId": "<string>",
          "type": "<string>",
          "form": [
            {
              "name": "<string>",
              "type": "<string>",
              "label": "<string>",
              "maxLenght": "<string>",
              "required": true
            }
          ],
          "status": true,
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "slug": "<string>",
          "file": {
            "id": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "institutionId": "<string>",
            "type": "<string>",
            "fileName": "<string>",
            "internalStorageUrl": "<string>",
            "url": "<string>",
            "size": 123,
            "extension": "<string>",
            "maskName": "<string>"
          }
        }
      }
    }
  ]
}

Token de Acesso

Authorization · string

Token de acesso (“Bearer” deve estar antes do token)

Corpo da Requisição

botId · string · required

O botId

fallBacks · array · required

Os fallBacks

O usuário deve possuir uma credencial que não esteja sendo usada pelo agente

Descrição da Resposta

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

items · array · required

Lista de configurações.

Show properties

id · string · required

Identificador único da configuração.

botId · string · required

ID do agente associado.

order · number · required

Ordem ou prioridade da configuração.

credentialId · string · required

ID da credencial associada.

model · string · required

Nome do modelo usado na configuração.

createdAt · Date · required

Data e hora de criação da configuração.

credential · object · required

Detalhes da credencial associada à configuração.

Show properties

id · string · required

Identificador único da credencial.

name · string · required

Nome da credencial.

userId · string · required

ID do usuário associado à credencial.

unityId · string · required

ID da unidade associada à credencial.

integrationId · string · required

ID da integração vinculada à credencial.

secretId · string · required

ID secreto da credencial.

status · boolean · required

Indica se a credencial está ativa.

virtualKey · string

Chave virtual associada à credencial.

createdAt · Date · required

Data e hora de criação da credencial.

updatedAt · Date

Data e hora da última atualização da credencial.

integration · object · required

Detalhes da integração vinculada à credencial.

Show properties

id · string · required

Identificador único da integração.

name · string · required

Nome da integração.

iconId · string · required

ID do ícone associado à integração.

type · string · required

Tipo da integração (ex: LLM).

form · array

Campos de configuração exigidos pela integração.

Show properties

name · string · required

Nome do campo (ex: API key).

type · string · required

Tipo de dado do campo.

label · string · required

Rótulo do campo.

maxLenght · string

Tamanho máximo do valor do campo.

required · boolean · required

Indica se o campo é obrigatório.

status · boolean · required

Indica se a integração está ativa.

createdAt · Date · required

Data e hora de criação da integração.

updatedAt · Date

Data e hora da última atualização da integração.

slug · string

Slug identificador da integração.

file · object · required

Detalhes do arquivo associado à integração.

Show properties

id · string · required

Identificador único do arquivo.

createdAt · Date · required

Data e hora de criação do arquivo.

updatedAt · Date

Data e hora da última atualização do arquivo.

institutionId · string · required

ID da instituição associada ao arquivo.

type · string · required

Tipo do arquivo (ex: WidgetHeaderIcon).

fileName · string · required

Nome do arquivo.

internalStorageUrl · string · required

URL de armazenamento interno do arquivo.

url · string · required

URL pública do arquivo.

size · number · required

Tamanho do arquivo em bytes.

extension · string · required

Extensão do arquivo (ex: png).

maskName · string

Nome da máscara opcional do arquivo.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido 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.