Obter Template
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/template/id/{id}import requests
url = "https://chat.api.toolzz.com.br/api/v1/template/id/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://chat.api.toolzz.com.br/api/v1/template/id/{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/template/id/{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/template/id/{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/template/id/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.api.toolzz.com.br/api/v1/template/id/{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{
"message": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"iconId": "<string>",
"templateIcon": {},
"institutionId": "<string>",
"institution": "<any>",
"unityId": "<string>",
"unity": "<any>",
"category": "<string>",
"prompt": "<string>",
"hasInstagram": true,
"hasMessenger": true,
"hasMulti": true,
"hasTools": true,
"hasVoice": true,
"hasWhatsapp": true,
"hasPlugin": true,
"active": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"voiceTemplate": [
"<any>"
],
"voicesTemplateCount": 123,
"pluginTemplate": [
"<any>"
],
"pluginsTemplateCount": 123,
"canCreatePlugins": true
}Template
Obter Template
Endpoint para obter detalhe de um template para criação de Agente
GET
/
api
/
v1
/
template
/
id
/
{id}
Obter Template
curl --request GET \
--url https://chat.api.toolzz.com.br/api/v1/template/id/{id}import requests
url = "https://chat.api.toolzz.com.br/api/v1/template/id/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://chat.api.toolzz.com.br/api/v1/template/id/{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/template/id/{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/template/id/{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/template/id/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.api.toolzz.com.br/api/v1/template/id/{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{
"message": "<string>",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"iconId": "<string>",
"templateIcon": {},
"institutionId": "<string>",
"institution": "<any>",
"unityId": "<string>",
"unity": "<any>",
"category": "<string>",
"prompt": "<string>",
"hasInstagram": true,
"hasMessenger": true,
"hasMulti": true,
"hasTools": true,
"hasVoice": true,
"hasWhatsapp": true,
"hasPlugin": true,
"active": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"voiceTemplate": [
"<any>"
],
"voicesTemplateCount": 123,
"pluginTemplate": [
"<any>"
],
"pluginsTemplateCount": 123,
"canCreatePlugins": true
}Token de Acesso
string
Token de acesso (“Bearer” deve estar antes do token)
string
ID do template
Descrição da Resposta
Abaixo você verá a descrição da resposta do agentestring
required
Mensagem de confirmação do retorno do template.
string
required
ID único do template.
string
required
Nome do template do agente.
string
required
Descrição do propósito ou função do template.
string
required
ID do ícone associado ao template.
object
required
Objeto contendo os dados do ícone do template, incluindo URLs, tipo, extensão, tamanho e metadados.
string
ID da instituição vinculada ao template (pode ser nulo).
any
Dados da instituição vinculada ao template (pode ser nulo).
string
ID da unidade organizacional associada (pode ser nulo).
any
Objeto com dados da unidade organizacional (pode ser nulo).
string
required
Categoria do template (exemplo: “support”).
string
required
Prompt principal do template, incluindo instruções e comportamento do agente.
boolean
required
Indica se o template tem integração com o Instagram.
boolean
required
Indica se o template tem integração com o Messenger.
boolean
required
Indica se o template suporta múltiplos agentes.
boolean
required
Indica se o template possui ferramentas integradas.
boolean
required
Indica se o template possui suporte a voz.
boolean
required
Indica se o template possui integração com o WhatsApp.
boolean
required
Indica se o template possui plugins integrados.
boolean
required
Indica se o template está ativo.
string
required
Data e hora de criação do template (formato ISO 8601).
string
required
Data e hora da última atualização do template (formato ISO 8601).
any[]
required
Lista de templates de voz associados (vazia por padrão).
number
required
Quantidade de templates de voz vinculados.
any[]
required
Lista de plugins associados ao template (vazia por padrão).
number
required
Quantidade de plugins vinculados ao template.
boolean
required
Indica se é permitido criar plugins para o template.