Get Document
curl --request GET \
--url https://api.example.com/api/knowledge-base/{documentation_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/knowledge-base/{documentation_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/knowledge-base/{documentation_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://api.example.com/api/knowledge-base/{documentation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/knowledge-base/{documentation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/knowledge-base/{documentation_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/knowledge-base/{documentation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"documentation_id": "doc_a1b2c3d4e5f6",
"name": "Product Manual.pdf",
"type": "file",
"client_id": "org_abc123",
"s3_key": "knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"s3_uri": "s3://bucket/knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"content_type": "application/pdf",
"size": 2450000,
"filename": "Product Manual.pdf",
"processing_status": "completed",
"page_count": 42,
"vector_count": 156,
"last_processed_at": "2024-01-16T14:45:00Z",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-16T14:45:00Z"
}
}
Knowledge Base
Get Document
GET
/
api
/
knowledge-base
/
{documentation_id}
Get Document
curl --request GET \
--url https://api.example.com/api/knowledge-base/{documentation_id} \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/knowledge-base/{documentation_id}"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Key': '<x-api-key>', 'X-Organization-Id': '<x-organization-id>'}
};
fetch('https://api.example.com/api/knowledge-base/{documentation_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://api.example.com/api/knowledge-base/{documentation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://api.example.com/api/knowledge-base/{documentation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/knowledge-base/{documentation_id}")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/knowledge-base/{documentation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"documentation_id": "doc_a1b2c3d4e5f6",
"name": "Product Manual.pdf",
"type": "file",
"client_id": "org_abc123",
"s3_key": "knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"s3_uri": "s3://bucket/knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"content_type": "application/pdf",
"size": 2450000,
"filename": "Product Manual.pdf",
"processing_status": "completed",
"page_count": 42,
"vector_count": 156,
"last_processed_at": "2024-01-16T14:45:00Z",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-16T14:45:00Z"
}
}
Get details of a specific knowledge base document.
Headers
string
required
Your API key for authentication.
string
required
The organization ID.
Path Parameters
string
required
The unique identifier of the document (format:
doc_[a-f0-9]{12,}).Permissions
kb:read(all roles)
Response
boolean
Indicates if the request was successful.
object
The full document object.
Show properties
Show properties
string
Unique document identifier.
string
Document name.
string
Document type (
file or text).string
Organization ID.
string
S3 key for file storage.
string
Full S3 URI.
string
MIME type (for files).
integer
File size in bytes (for files).
string
Original filename (for files).
string
Text content (for text documents).
integer
Word count (for text documents).
string
Processing status:
pending, processing, completed, or failed.string
Error message if processing failed.
integer
Number of pages (for files).
integer
Number of vectors uploaded to Pinecone.
string
ISO 8601 timestamp of last processing attempt.
string
ISO 8601 timestamp of creation.
string
ISO 8601 timestamp of last update.
{
"success": true,
"data": {
"documentation_id": "doc_a1b2c3d4e5f6",
"name": "Product Manual.pdf",
"type": "file",
"client_id": "org_abc123",
"s3_key": "knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"s3_uri": "s3://bucket/knowledge-base/org_abc123/doc_a1b2c3d4e5f6.pdf",
"content_type": "application/pdf",
"size": 2450000,
"filename": "Product Manual.pdf",
"processing_status": "completed",
"page_count": 42,
"vector_count": 156,
"last_processed_at": "2024-01-16T14:45:00Z",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-16T14:45:00Z"
}
}
⌘I