Obter documentos
curl --request GET \
--url https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents', 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://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"name": "Manual do Produto",
"description": "Manual completo do usuário do produto",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Ativo",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Website da Empresa",
"description": "Conteúdo principal do website",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processando",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Base de conhecimento não encontrada."
}
Bases de Conhecimento
Obter documentos
Obter todos os documentos de uma base de conhecimento
GET
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
Obter documentos
curl --request GET \
--url https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents', 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://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"name": "Manual do Produto",
"description": "Manual completo do usuário do produto",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Ativo",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Website da Empresa",
"description": "Conteúdo principal do website",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processando",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Base de conhecimento não encontrada."
}
Este endpoint retorna uma lista de todos os documentos em uma base de conhecimento específica.
Parâmetros de Rota
integer
required
O identificador único da base de conhecimento
Resposta
array
Array de objetos documento
Show propriedades do documento
Show propriedades do documento
integer
O identificador único do documento
string
O nome do documento
string
Descrição opcional do documento
string
Tipo do documento:
website, pdf, txt, ou docxstring
Rótulo de tipo legível
string
Status de processamento:
processing, active, ou failedstring
Rótulo de status legível
string
Timestamp ISO 8601 da criação
string
Timestamp ISO 8601 da última atualização
{
"data": [
{
"id": 1,
"name": "Manual do Produto",
"description": "Manual completo do usuário do produto",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Ativo",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Website da Empresa",
"description": "Conteúdo principal do website",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processando",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Base de conhecimento não encontrada."
}
Status dos Documentos
| Status | Descrição |
|---|---|
processing | Documento está sendo analisado e incorporado no banco de dados de vetores |
active | Documento foi processado e está pronto para uso |
failed | Processamento do documento falhou |
⌘I

