Get a knowledge base by slug

Retrieves a knowledge base with its processing status, document count, chunk count, and a list of all documents. Use this to verify that uploaded documents have finished indexing before relying on them in prompts.

GET /api/v1/knowledge-bases/{slug}

PromptJuggler PHP SDK

PHP

$kb = $pj->getKnowledgeBase('product-docs');

200

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

200

application/json

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

Show child attributes