Upload documents to a knowledge base

Uploads one or more files to a knowledge base for chunking and embedding. Documents are processed asynchronously. Listen for the knowledgedocument.finished webhook or poll the document endpoint to know when they are searchable.

POST /api/v1/knowledge-bases/{slug}/documents

PromptJuggler PHP SDK

PHP

$docs = $pj->uploadDocuments('product-docs', ['manual.pdf' => file_get_contents('manual.pdf')]);

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "fileName": "<string>",
    "bytes": 123,
    "chunkCount": 123
  }
]

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

Body

multipart/form-data

files · file[]

Response

200

application/json

Documents created

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