Quick Start
Get up and running with Jabrod in 5 minutes.
1. Get Your API Key
Navigate to API Keys
Go to User > API Keys
Create a new key
Click Create Key and copy your key (starts with jb_)
Store your API key securely. It will only be shown once!
2. Install the SDK
3. Initialize the Client
import { JabrodClient } from 'jabrod' ;
const jabrod = new JabrodClient ({
apiKey: process . env . JABROD_API_KEY
});
4. Create a Knowledge Base
const kb = await jabrod . kb . create ({
name: 'My Documents' ,
description: 'Product documentation'
});
console . log ( 'Created KB:' , kb . id );
5. Upload Documents
// Upload a file
await jabrod . kb . upload ({
kbId: kb . id ,
file: myFile
});
// Or upload text directly
await jabrod . kb . uploadText ({
kbId: kb . id ,
content: 'Your text content here...' ,
name: 'notes.txt'
});
6. Query with RAG
Semantic Search (without LLM)
const result = await jabrod . rag
. queryBuilder ()
. withQuery ( 'What is the refund policy?' )
. withKnowledgeBase ( kb . id )
. withTopK ( 5 )
. execute ();
console . log ( result . chunks );
Chat with AI (with LLM)
const response = await jabrod . rag
. chatBuilder ()
. withMessage ( 'Summarize the key points' )
. withKnowledgeBase ( kb . id )
. withModel ( 'gpt-4o-mini' )
. execute ();
console . log ( response . message );
console . log ( 'Sources:' , response . sources );
Next Steps
SDK Reference Explore all SDK features
API Reference Use the REST API directly