Obter Agente
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/bot/{id}import requests
url = "https://chat.api.toolzz.com.br/api/v1/bot/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://chat.api.toolzz.com.br/api/v1/bot/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://chat.api.toolzz.com.br/api/v1/bot/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://chat.api.toolzz.com.br/api/v1/bot/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.api.toolzz.com.br/api/v1/bot/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"metaprompt": "<string>",
"description": "<string>",
"folders": [
{}
],
"plugins": [
{}
],
"botGenAI": [
{
"isDefault": true,
"messagesLimit": 123,
"charactersLimit": 123,
"temperature": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123,
"topK": 123,
"messagesQuery": 123,
"id": "<string>",
"botId": "<string>",
"genAIId": "<string>",
"genAIKey": "<string>",
"genAIOrganization": "<string>",
"genAIModelId": "<string>",
"assistantId": "<string>",
"credentialId": "<string>",
"analyticsCredentialId": "<string>",
"model": "<string>",
"tools": [
{}
],
"whatsappCredentialId": "<string>",
"instagramCredentialId": "<string>",
"messengerCredentialId": "<string>",
"messengerCredential": {
"integration": {}
},
"genAIModel": {},
"genAI": {},
"instagramCredential": {
"integration": {}
},
"analyticsCredential": {
"integration": {}
},
"whatsappCredential": {
"integration": {}
},
"credential": {
"status": true,
"id": "<string>",
"name": "<string>",
"userId": "<string>",
"unityId": "<string>",
"integrationId": "<string>",
"secretId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"virtualKey": "<string>",
"integration": {
"status": true,
"id": "<string>",
"name": "<string>",
"type": "<string>",
"form": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"maxLenght": "<string>",
"required": true
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"iconId": "<string>",
"validationEndpoint": "<string>",
"slug": "<string>",
"icon": {
"id": "<string>",
"institutionId": "<string>",
"type": "<string>",
"fileName": "<string>",
"internalStorageUrl": "<string>",
"url": "<string>",
"maskName": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"extension": "<string>",
"size": 123,
"numberWords": 123
}
}
}
}
],
"assistantId": "<string>",
"IconFile": {},
"tags": [
{}
],
"unityId": "<string>",
"progressStatus": "<string>",
"safeMode": true,
"institutionId": "<string>",
"isActivated": true,
"botMonetization": {},
"hasMonetization": true,
"hasAnalytics": true,
"hasMulti": true,
"isAdvancedBot": true,
"hasTools": true,
"hasVoice": true,
"botVoiceConfig": [
{}
],
"hasPlugins": true,
"hasWhatsapp": true,
"hasInstagram": true,
"hasMessenger": true,
"botMultiAgents": [
{}
],
"favorites": [
{}
],
"botFallBack": [
{}
]
}Agente
Obter Agente
GET
/
api
/
v1
/
bot
/
{id}
Obter Agente
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/bot/{id}import requests
url = "https://chat.api.toolzz.com.br/api/v1/bot/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://chat.api.toolzz.com.br/api/v1/bot/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://chat.api.toolzz.com.br/api/v1/bot/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://chat.api.toolzz.com.br/api/v1/bot/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.api.toolzz.com.br/api/v1/bot/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"metaprompt": "<string>",
"description": "<string>",
"folders": [
{}
],
"plugins": [
{}
],
"botGenAI": [
{
"isDefault": true,
"messagesLimit": 123,
"charactersLimit": 123,
"temperature": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123,
"topK": 123,
"messagesQuery": 123,
"id": "<string>",
"botId": "<string>",
"genAIId": "<string>",
"genAIKey": "<string>",
"genAIOrganization": "<string>",
"genAIModelId": "<string>",
"assistantId": "<string>",
"credentialId": "<string>",
"analyticsCredentialId": "<string>",
"model": "<string>",
"tools": [
{}
],
"whatsappCredentialId": "<string>",
"instagramCredentialId": "<string>",
"messengerCredentialId": "<string>",
"messengerCredential": {
"integration": {}
},
"genAIModel": {},
"genAI": {},
"instagramCredential": {
"integration": {}
},
"analyticsCredential": {
"integration": {}
},
"whatsappCredential": {
"integration": {}
},
"credential": {
"status": true,
"id": "<string>",
"name": "<string>",
"userId": "<string>",
"unityId": "<string>",
"integrationId": "<string>",
"secretId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"virtualKey": "<string>",
"integration": {
"status": true,
"id": "<string>",
"name": "<string>",
"type": "<string>",
"form": [
{
"name": "<string>",
"type": "<string>",
"label": "<string>",
"maxLenght": "<string>",
"required": true
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"iconId": "<string>",
"validationEndpoint": "<string>",
"slug": "<string>",
"icon": {
"id": "<string>",
"institutionId": "<string>",
"type": "<string>",
"fileName": "<string>",
"internalStorageUrl": "<string>",
"url": "<string>",
"maskName": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"extension": "<string>",
"size": 123,
"numberWords": 123
}
}
}
}
],
"assistantId": "<string>",
"IconFile": {},
"tags": [
{}
],
"unityId": "<string>",
"progressStatus": "<string>",
"safeMode": true,
"institutionId": "<string>",
"isActivated": true,
"botMonetization": {},
"hasMonetization": true,
"hasAnalytics": true,
"hasMulti": true,
"isAdvancedBot": true,
"hasTools": true,
"hasVoice": true,
"botVoiceConfig": [
{}
],
"hasPlugins": true,
"hasWhatsapp": true,
"hasInstagram": true,
"hasMessenger": true,
"botMultiAgents": [
{}
],
"favorites": [
{}
],
"botFallBack": [
{}
]
}string
Token de acesso (“Bearer” deve estar antes do token)
uuid
ID do agente
Descrição da Resposta
Abaixo você verá a descrição da resposta do agentestring
required
Identificador único do agente.
string
required
Nome do agente.
string
Prompt principal utilizado pelo agente.
string
Metaprompt com instruções avançadas de comportamento, linguagem e formatação.
string
Descrição do agente.
array
Lista de pastas associadas ao agente.
array
Lista de plugins associados ao agente.
array
Configurações de IA generativa associadas ao agente.
Show BotGenAI properties
Show BotGenAI properties
boolean
required
Indica se esta é a configuração padrão do agente.
number
Limite máximo de mensagens.
number
Limite máximo de caracteres.
number
Controla o nível de criatividade das respostas.
number
Define o recorte probabilístico das respostas geradas.
number
Penalidade aplicada para reduzir repetições nas respostas.
number
Penalidade aplicada para incentivar novos tópicos nas respostas.
number
Limita a quantidade de tokens candidatos considerados na geração.
number
Quantidade de mensagens utilizadas como contexto.
string
required
Identificador da configuração de IA generativa.
string
required
Identificador do agente associado.
string
Identificador do provedor de IA generativa.
string
Chave do provedor de IA generativa.
string
Organização associada ao provedor de IA generativa.
string
Identificador do modelo de IA generativa.
string
Identificador do assistente externo vinculado.
string
Identificador da credencial principal.
string
Identificador da credencial de analytics.
string
Modelo utilizado pelo agente.
array
Ferramentas associadas à configuração.
string
Identificador da credencial do WhatsApp.
string
Identificador da credencial do Instagram.
string
Identificador da credencial do Messenger.
object
Informações da credencial do Messenger.
Show Messenger credential properties
Show Messenger credential properties
object
Integração associada à credencial do Messenger.
object
Dados do modelo de IA generativa.
object
Dados do provedor de IA generativa.
object
Informações da credencial do Instagram.
Show Instagram credential properties
Show Instagram credential properties
object
Integração associada à credencial do Instagram.
object
Informações da credencial de analytics.
Show Analytics credential properties
Show Analytics credential properties
object
Integração associada à credencial de analytics.
object
Informações da credencial do WhatsApp.
Show Whatsapp credential properties
Show Whatsapp credential properties
object
Integração associada à credencial do WhatsApp.
object
Credencial principal utilizada pelo agente.
Show Credential properties
Show Credential properties
boolean
required
Indica se a credencial está ativa.
string
required
Identificador da credencial.
string
required
Nome da credencial.
string
required
Identificador do usuário associado à credencial.
string
required
Identificador da unidade associada à credencial.
string
required
Identificador da integração da credencial.
string
required
Identificador secreto da credencial.
string
required
Data de criação da credencial.
string
Data da última atualização da credencial.
string
Chave virtual associada à credencial.
object
Integração associada à credencial.
Show Integration properties
Show Integration properties
boolean
required
Indica se a integração está ativa.
string
required
Identificador da integração.
string
required
Nome da integração.
string
required
Tipo da integração.
array
string
required
Data de criação da integração.
string
Data da última atualização da integração.
string
Identificador do ícone da integração.
string
Endpoint de validação da integração.
string
Slug da integração.
object
Ícone associado à integração.
Show Icon properties
Show Icon properties
string
required
Identificador do ícone.
string
required
Identificador da instituição associada ao ícone.
string
required
Tipo do ícone.
string
required
Nome do arquivo do ícone.
string
required
URL interna do armazenamento do ícone.
string
required
URL pública do ícone.
string
required
Nome mascarado do arquivo.
string
required
Data de criação do ícone.
string
Data da última atualização do ícone.
string
Extensão do arquivo.
number
Tamanho do arquivo em bytes.
number
Quantidade de palavras associadas ao recurso, quando aplicável.
string
Identificador do assistente externo associado ao agente.
object
Arquivo de ícone associado ao agente.
array
Lista de tags associadas ao agente.
string
required
Identificador da unidade associada ao agente.
string
Status de progresso do agente.
boolean
Indica se o modo seguro está habilitado.
string
Identificador da instituição associada.
boolean
Indica se o agente está ativado.
object
Configurações de monetização do agente.
boolean
Indica se o agente possui monetização habilitada.
boolean
Indica se o agente possui analytics habilitado.
boolean
Indica se o agente possui suporte multicanal.
boolean
Indica se o agente utiliza configurações avançadas.
boolean
Indica se o agente possui ferramentas habilitadas.
boolean
Indica se o agente possui recurso de voz habilitado.
array
Lista de configurações de voz do agente.
boolean
Indica se o agente possui plugins habilitados.
boolean
Indica se o agente possui integração com WhatsApp.
boolean
Indica se o agente possui integração com Instagram.
boolean
Indica se o agente possui integração com Messenger.
array
Lista de com ID de agente associados ao multiagente se habilitado.
array
Lista de favoritos associados ao agente.
array
Lista de configurações de fallback do agente.