Skip to main content
GET
/
api
/
v1
/
knowledge-bases
/
{slug}
PromptJuggler PHP SDK
$kb = $pj->getKnowledgeBase('product-docs');
const kb = await pj.getKnowledgeBase('product-docs');
kb = pj.get_knowledge_base('product-docs')
KnowledgeBaseResponse kb = pj.getKnowledgeBase("product-docs");
kb, err := pj.GetKnowledgeBase(ctx, "product-docs")
curl --request GET \
--url https://promptjuggler.com/api/v1/knowledge-bases/{slug} \
--header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://promptjuggler.com/api/v1/knowledge-bases/{slug}', 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-bases/{slug}")

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

Authorizations

Authorization
string
header
required

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

Path Parameters

slug
string
required

Knowledge base handle

Response

Knowledge base with documents

Knowledge base with documents

id
string<uuid>
required

Knowledge base ID

status
enum<string>
required

Processing status

Available options:
pending,
ready,
failed
documentCount
integer
required

Total number of documents

chunkCount
integer
required

Total number of chunks across all documents

documents
object[]
required