Get documents
curl --request GET \
--url https://app.voiz.mx/api/user/knowledgebases/{knowledgebaseId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/api/user/knowledgebases/{knowledgebaseId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voiz.mx/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": "Product Manual",
"description": "Complete product user manual",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Active",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Company Website",
"description": "Main website content",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processing",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Knowledgebase not found."
}
Knowledgebases
Get documents
Get all documents in a knowledgebase
GET
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
Get documents
curl --request GET \
--url https://app.voiz.mx/api/user/knowledgebases/{knowledgebaseId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/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://app.voiz.mx/api/user/knowledgebases/{knowledgebaseId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voiz.mx/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": "Product Manual",
"description": "Complete product user manual",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Active",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Company Website",
"description": "Main website content",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processing",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Knowledgebase not found."
}
This endpoint returns a list of all documents in a specific knowledgebase.
Path Parameters
integer
required
The unique identifier of the knowledgebase
Response
array
Array of document objects
Show document properties
Show document properties
integer
The unique identifier of the document
string
The name of the document
string
Optional description of the document
string
Document type:
website, pdf, txt, or docxstring
Human-readable type label
string
Processing status:
processing, active, or failedstring
Human-readable status label
string
ISO 8601 timestamp of creation
string
ISO 8601 timestamp of last update
{
"data": [
{
"id": 1,
"name": "Product Manual",
"description": "Complete product user manual",
"type": "pdf",
"type_label": "PDF",
"status": "active",
"status_label": "Active",
"created_at": "2025-01-05T10:30:00.000000Z",
"updated_at": "2025-01-05T10:35:00.000000Z"
},
{
"id": 2,
"name": "Company Website",
"description": "Main website content",
"type": "website",
"type_label": "Website",
"status": "processing",
"status_label": "Processing",
"created_at": "2025-01-08T09:00:00.000000Z",
"updated_at": "2025-01-08T09:00:00.000000Z"
}
]
}
{
"error": "Knowledgebase not found."
}
Document Statuses
| Status | Description |
|---|---|
processing | Document is being parsed and embedded into the vector database |
active | Document has been processed and is ready for use |
failed | Document processing failed |
⌘I

