Criar Fallback

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

import requests

url = "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback"

payload = {
    "botId": "<string>",
    "fallBacks": [{}]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({botId: '<string>', fallBacks: [{}]})
};

fetch('https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'botId' => '<string>',
    'fallBacks' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback"

	payload := strings.NewReader("{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback")
  .header("Content-Type", "application/json")
  .body("{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
          }
        }
      }
    }
  ]
}

POST

api

bot

configuration

fallback

Criar Fallback

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

import requests

url = "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback"

payload = {
    "botId": "<string>",
    "fallBacks": [{}]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({botId: '<string>', fallBacks: [{}]})
};

fetch('https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'botId' => '<string>',
    'fallBacks' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback"

	payload := strings.NewReader("{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback")
  .header("Content-Type", "application/json")
  .body("{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"botId\": \"<string>\",\n  \"fallBacks\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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

string

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

Corpo da Requisição

string

required

O botId

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

array

required

Lista de configurações.

Show properties

string

required

Identificador único da configuração.

string

required

ID do agente associado.

number

required

Ordem ou prioridade da configuração.

string

required

ID da credencial associada.

string

required

Nome do modelo usado na configuração.

Date

required

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

object

required

Detalhes da credencial associada à configuração.

Show properties

string

required

Identificador único da credencial.

string

required

Nome da credencial.

string

required

ID do usuário associado à credencial.

string

required

ID da unidade associada à credencial.

string

required

ID da integração vinculada à credencial.

string

required

ID secreto da credencial.

boolean

required

Indica se a credencial está ativa.

string

Chave virtual associada à credencial.

Date

required

Data e hora de criação da credencial.

Date

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

object

required

Detalhes da integração vinculada à credencial.

Show properties

string

required

Identificador único da integração.

string

required

Nome da integração.

string

required

ID do ícone associado à integração.

string

required

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

array

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

Show properties

string

required

Nome do campo (ex: API key).

string

required

Tipo de dado do campo.

string

required

Rótulo do campo.

string

Tamanho máximo do valor do campo.

boolean

required

Indica se o campo é obrigatório.

boolean

required

Indica se a integração está ativa.

Date

required

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

Date

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

string

Slug identificador da integração.

object

required

Detalhes do arquivo associado à integração.

Show properties

string

required

Identificador único do arquivo.

Date

required

Data e hora de criação do arquivo.

Date

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

string

required

ID da instituição associada ao arquivo.

string

required

Tipo do arquivo (ex: WidgetHeaderIcon).

string

required

Nome do arquivo.

string

required

URL de armazenamento interno do arquivo.

string

required

URL pública do arquivo.

number

required

Tamanho do arquivo em bytes.

string

required

Extensão do arquivo (ex: png).

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.

​Token de Acesso

​Corpo da Requisição

​Descrição da Resposta

​Segurança

Token de Acesso

Corpo da Requisição

Descrição da Resposta

Segurança