Skip to main content
GET
/
api
/
v1
/
knowledge-documents
/
{id}
PromptJuggler PHP SDK
$doc = $pj->getKnowledgeDocument('01J...');
const doc = await pj.getKnowledgeDocument('01J...');
doc = pj.get_knowledge_document('01J...')
KnowledgeDocumentResponse doc = pj.getKnowledgeDocument("01J...");
doc, err := pj.GetKnowledgeDocument(ctx, "01J...")
curl --request GET \
--url https://promptjuggler.com/api/v1/knowledge-documents/{id} \
--header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://promptjuggler.com/api/v1/knowledge-documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
require 'uri'
require 'net/http'

url = URI("https://promptjuggler.com/api/v1/knowledge-documents/{id}")

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
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fileName": "<string>",
  "bytes": 123,
  "chunkCount": 123
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Document ID

Response

Knowledge document

Knowledge document

id
string<uuid>
required

Document ID

status
enum<string>
required

Processing status

Available options:
pending,
sealed,
ready,
failed
fileName
string
required

Original file name

bytes
integer
required

File size in bytes

chunkCount
integer
required

Number of chunks extracted