Obter Instituição

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/institution/id/{id}

const options = {method: 'GET'};

fetch('https://chat.api.toolzz.com.br/api/v1/institution/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/institution/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/institution/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))

}

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/institution/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

{
  "id": "<string>",
  "institutionToolzzId": 123,
  "aiDefaultModel": "<string>",
  "chatStyle": "<string>",
  "primaryColorHex": "<string>",
  "secondaryColorHex": "<string>",
  "lightModeLogoUrl": "<string>",
  "lightModeAltLogoUrl": "<string>",
  "darkModeLogoUrl": "<string>",
  "darkModeAltLogoUrl": "<string>",
  "faviconUrl": "<string>",
  "theme": "<string>",
  "subdomain": "<string>",
  "customDomain": "<string>",
  "apiConversationUrl": "<string>",
  "userId": "<string>",
  "cnpj": "<string>",
  "isActive": true,
  "name": "<string>",
  "description": "<string>",
  "safetyPlan": "<string>",
  "adminId": "<string>",
  "customerId": "<string>",
  "subscriptionId": "<string>",
  "institutionPlan": {
    "id": "<string>",
    "institutionId": "<string>",
    "unitiesLimit": 123,
    "botsLimit": 123,
    "widgetsLimit": 123,
    "knowledgeBasesLimit": 123,
    "pluginsLimit": 123,
    "vectorsLimit": 123,
    "createdAt": {},
    "updatedAt": {}
  }
}

GET

api

institution

{id}

Obter Instituição

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/institution/id/{id}

const options = {method: 'GET'};

fetch('https://chat.api.toolzz.com.br/api/v1/institution/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/institution/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/institution/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))

}

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/institution/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

{
  "id": "<string>",
  "institutionToolzzId": 123,
  "aiDefaultModel": "<string>",
  "chatStyle": "<string>",
  "primaryColorHex": "<string>",
  "secondaryColorHex": "<string>",
  "lightModeLogoUrl": "<string>",
  "lightModeAltLogoUrl": "<string>",
  "darkModeLogoUrl": "<string>",
  "darkModeAltLogoUrl": "<string>",
  "faviconUrl": "<string>",
  "theme": "<string>",
  "subdomain": "<string>",
  "customDomain": "<string>",
  "apiConversationUrl": "<string>",
  "userId": "<string>",
  "cnpj": "<string>",
  "isActive": true,
  "name": "<string>",
  "description": "<string>",
  "safetyPlan": "<string>",
  "adminId": "<string>",
  "customerId": "<string>",
  "subscriptionId": "<string>",
  "institutionPlan": {
    "id": "<string>",
    "institutionId": "<string>",
    "unitiesLimit": 123,
    "botsLimit": 123,
    "widgetsLimit": 123,
    "knowledgeBasesLimit": 123,
    "pluginsLimit": 123,
    "vectorsLimit": 123,
    "createdAt": {},
    "updatedAt": {}
  }
}

Token de Acesso

string

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

Parâmetros

string

ID da instituição

Descrição da Resposta

O endpoint retorna uma resposta em formato JSON com a confirmação da solicitação.

string

Identificador único (opcional).

number

required

ID da instituição no sistema Toolzz.

string

required

Modelo de IA padrão utilizado pela instituição.

string

required

Configuração de estilo da interface do chat.

string

required

Cor primária em formato HEX.

string

required

Cor secundária em formato HEX.

string

required

URL do logo para o modo claro.

string

URL do logo alternativo para o modo claro (opcional).

string

required

URL do logo para o modo escuro.

string

URL do logo alternativo para o modo escuro (opcional).

string

required

URL do favicon.

string

required

Configuração de tema do sistema.

string

required

Subdomínio associado à instituição.

string

Domínio personalizado associado à instituição (opcional).

string

URL do endpoint de conversação da API (opcional).

uuid

required

Identificador do usuário associado.

string

required

CNPJ (Cadastro Nacional da Pessoa Jurídica) da instituição.

boolean

required

Indica se a instituição está ativa.

string

required

Nome da instituição.

string

required

Descrição da instituição.

string

required

Plano de segurança associado à instituição.

uuid

required

ID do administrador associado à instituição.

uuid

required

ID do cliente associado à instituição.

uuid

required

ID do plano de assinatura da instituição.

InstitutionPlan

required

Detalhes do plano da instituição.

Show Propriedades

uuid

required

Identificador único.

uuid

required

ID da instituição associada.

number

required

Limite de unidades organizacionais.

number

required

Número máximo de agentes permitidos.

number

required

Limite de widgets.

number

required

Número máximo de Bases de Conhecimento permitidas.

number

required

Limite de plugins.

number

required

Número máximo de vetores permitidos.

date-time

required

Data e hora de criação do registro.

date-time

required

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

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

​Parâmetros

​Descrição da Resposta

​Segurança

Token de Acesso

Parâmetros

Descrição da Resposta

Segurança