Skip to main content
GET
/
api
/
v1
/
knowledge-bases
/
{slug}
Get a knowledge base by slug
curl --request GET \
  --url https://promptjuggler.com/api/v1/api/v1/knowledge-bases/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentCount": 123,
  "chunkCount": 123,
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fileName": "<string>",
      "bytes": 123,
      "mimeType": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptjuggler.com/llms.txt

Use this file to discover all available pages before exploring further.

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