TypeScript
import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210' }); async function getAllKnowledgeBase() { const response = await client.knowledgeBase.getAll({ offset: 0, limit: 10, type: 'faq' // optional: filter by 'faq' or 'document' }); console.log(response); } getAllKnowledgeBase();
{ "data": [ { "context_id": "ai-context-aaauajhjdgjnomr", "type": "faq", "question": "How do I connect WhatsApp?", "answer": "You can connect WhatsApp by scanning the QR code in Settings.", "attachments": [], "embedding": [ -0.020637017, -0.0148050785, 0.02985098, 0.023778915, "..." ], "created_at": "2025-01-20T10:00:00Z", "updated_at": "2025-01-20T10:00:00Z" }, { "document_id": "doc_xyz789", "type": "document", "filename": "user-guide.pdf", "chunks_count": 15, "created_at": "2025-01-19T15:30:00Z", "updated_at": "2025-01-19T15:30:00Z" } ], "total": 2, "offset": 0, "limit": 10 }
This endpoint retrieves a paginated list of all knowledge base items (FAQs and Documents)
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
"0"
"10"
"faq"
200 OK
An array of knowledge base items (FAQs and Documents)
Total count of items
Current offset
Current limit
Was this page helpful?