Obter Base de Conhecimento por Unidade

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

const options = {method: 'GET'};

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

{
  "items": [
    {
      "id": "<string>",
      "unityId": "<string>",
      "kbCreatorId": "<string>",
      "kbInstitutionId": "<string>",
      "kbStatus": 123,
      "kbName": "<string>",
      "kbDescription": "<string>",
      "kbIconImg": "<string>",
      "kbFolder": [
        {
          "id": "<string>",
          "name": "<string>",
          "knowLedgeBaseId": "<string>",
          "isRoot": true,
          "institutionId": "<string>",
          "knowLedgeBaseFile": [
            {
              "id": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "institutionId": "<string>",
              "fileName": "<string>",
              "internalStorageUrl": "<string>",
              "url": "<string>",
              "size": 123,
              "extension": "<string>",
              "maskName": "<string>",
              "integrationId": "<string>",
              "customData": [
                {}
              ]
            }
          ],
          "_count": {
            "knowLedgeBaseFile": 123
          }
        }
      ],
      "documentsInfo": {
        "size": 123,
        "documentCount": 123
      },
      "isActivated": true
    }
  ],
  "knowledgeBaseCount": 123,
  "activeCount": 123,
  "knowledgeBaseLimit": 123
}

GET

api

knowledge

unity

{id}

Obter Base de Conhecimento por Unidade

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

const options = {method: 'GET'};

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

{
  "items": [
    {
      "id": "<string>",
      "unityId": "<string>",
      "kbCreatorId": "<string>",
      "kbInstitutionId": "<string>",
      "kbStatus": 123,
      "kbName": "<string>",
      "kbDescription": "<string>",
      "kbIconImg": "<string>",
      "kbFolder": [
        {
          "id": "<string>",
          "name": "<string>",
          "knowLedgeBaseId": "<string>",
          "isRoot": true,
          "institutionId": "<string>",
          "knowLedgeBaseFile": [
            {
              "id": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "institutionId": "<string>",
              "fileName": "<string>",
              "internalStorageUrl": "<string>",
              "url": "<string>",
              "size": 123,
              "extension": "<string>",
              "maskName": "<string>",
              "integrationId": "<string>",
              "customData": [
                {}
              ]
            }
          ],
          "_count": {
            "knowLedgeBaseFile": 123
          }
        }
      ],
      "documentsInfo": {
        "size": 123,
        "documentCount": 123
      },
      "isActivated": true
    }
  ],
  "knowledgeBaseCount": 123,
  "activeCount": 123,
  "knowledgeBaseLimit": 123
}

Token de Acesso

string

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

Descrição do Body

string

required

ID da unidade

Descrição da Resposta

A resposta do endpoint retorna um JSON com a confirmação da solicitação.

array

required

Lista de Bases de Conhecimento.

Show Item properties

string

required

Identificador único da Base de Conhecimento.

string

required

Identificador da unidade associada.

string

required

ID do criador da Base de Conhecimento.

string

required

Identificador da instituição proprietária da Base de Conhecimento.

number

required

Status da Base de Conhecimento (ex: 1 para ativa).

string

required

Nome da Base de Conhecimento.

string

Descrição da Base de Conhecimento.

string

URL do ícone da Base de Conhecimento.

array

Lista de pastas dentro da Base de Conhecimento.

Show Folder properties

string

required

Identificador único da pasta.

string

required

Nome da pasta.

string

required

ID da Base de Conhecimento associada.

boolean

required

Indica se a pasta é raiz.

string

required

ID da instituição proprietária da pasta.

array

Lista de arquivos na pasta.

Show File properties

string

required

Identificador único do arquivo.

string

required

Data/hora de criação do arquivo.

string

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

string

required

ID da instituição proprietária do arquivo.

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.

string

Nome da máscara do arquivo.

string

ID da integração associada ao arquivo (se houver).

array

Metadados personalizados associados ao arquivo.

object

Detalhes de contagem para a pasta.

Show Count properties

number

required

Número de arquivos na pasta.

object

Resumo dos documentos na Base de Conhecimento.

Show Document info properties

number

required

Tamanho total dos documentos em bytes.

number

required

Número total de documentos.

boolean

required

Indica se a Base de Conhecimento está ativada.

number

required

Número total de Bases de Conhecimento.

number

required

Número de Bases de Conhecimento ativas.

number

required

Limite máximo de Bases de Conhecimento permitidas.

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.

Código de Resposta

Exemplos de erro de segurança

Show error 🚦

string

Resposta de sucesso da requisição

string

Falha na requisição

​Token de Acesso

​Descrição do Body

​Descrição da Resposta

​Segurança

​Código de Resposta

Token de Acesso

Descrição do Body

Descrição da Resposta

Segurança

Código de Resposta