Skip to main content
GET
/
api
/
v1
/
template
/
id
/
{id}
Obter Template
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/template/id/{id}
{
  "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
}
id
string
ID do template

Descrição da Resposta

Abaixo você verá a descrição da resposta do agente
message
string
required
Mensagem de confirmação do retorno do template.
id
string
required
ID único do template.
name
string
required
Nome do template do agente.
description
string
required
Descrição do propósito ou função do template.
iconId
string
required
ID do ícone associado ao template.
templateIcon
object
required
Objeto contendo os dados do ícone do template, incluindo URLs, tipo, extensão, tamanho e metadados.
institutionId
string
ID da instituição vinculada ao template (pode ser nulo).
institution
any
Dados da instituição vinculada ao template (pode ser nulo).
unityId
string
ID da unidade organizacional associada (pode ser nulo).
unity
any
Objeto com dados da unidade organizacional (pode ser nulo).
category
string
required
Categoria do template (exemplo: “support”).
prompt
string
required
Prompt principal do template, incluindo instruções e comportamento do agente.
hasInstagram
boolean
required
Indica se o template tem integração com o Instagram.
hasMessenger
boolean
required
Indica se o template tem integração com o Messenger.
hasMulti
boolean
required
Indica se o template suporta múltiplos agentes.
hasTools
boolean
required
Indica se o template possui ferramentas integradas.
hasVoice
boolean
required
Indica se o template possui suporte a voz.
hasWhatsapp
boolean
required
Indica se o template possui integração com o WhatsApp.
hasPlugin
boolean
required
Indica se o template possui plugins integrados.
active
boolean
required
Indica se o template está ativo.
createdAt
string
required
Data e hora de criação do template (formato ISO 8601).
updatedAt
string
required
Data e hora da última atualização do template (formato ISO 8601).
voiceTemplate
any[]
required
Lista de templates de voz associados (vazia por padrão).
voicesTemplateCount
number
required
Quantidade de templates de voz vinculados.
pluginTemplate
any[]
required
Lista de plugins associados ao template (vazia por padrão).
pluginsTemplateCount
number
required
Quantidade de plugins vinculados ao template.
canCreatePlugins
boolean
required
Indica se é permitido criar plugins para o template.