Quick Start Guide
Get started with the Knowledge Base Optimizer in minutes
What is Knowledge Base Optimizer?
Knowledge Base Optimizer is an AI-powered platform that helps organizations enhance their documentation and knowledge bases through intelligent processing and optimization. Transform your existing content into clearer, more comprehensive, and more valuable resources.
Key Features Overview
Multi-Source Integration
Import content from files, websites, and other external knowledge base sources into unified projects.
AI-Powered Processing
Automatically enhance and optimize your content with custom AI processing instructions and quality assurance.
Real-Time Monitoring
Track processing progress in real-time with detailed status updates and comprehensive reporting.
Getting Started in 4 Simple Steps
Create Your First Project
Start by creating a new project to organize your knowledge base content. Give it a descriptive name and description.
Create ProjectAdd Content Sources
Import your existing knowledge base content from multiple sources. In your project dashboard, you'll find several options:
- • File Upload: Drag & drop or select PDF, Markdown files
- • Website Import: Add URLs to scrape content from web pages
- • Integrations: Connect external knowledge bases via Settings → Integrations, then import content from those sources
Configure AI Processing (Optional)
Customize how the AI optimizes your content. In your project dashboard, you'll see an "Advanced Settings" section where you can:
- • Processing Instructions: Tell the AI your specific optimization goals and how to enhance your content
Monitor & Export Results
Track processing progress and download your optimized content. Here's where to find everything:
- • Real-time Monitoring: Processing status appears in your project dashboard with live updates
- • Progress Details: Click on any processing project to see step-by-step progress
- • Document Viewer: Review optimized content in the built-in editor
- • Export Options: Download individual files or use bulk export for all documents
Use your own key
You can use your own Gemini API key.
Here is guide of how to get your own API key and use it with Knowledge Base Optimizer.
Use your own keyAPI Integration
🚀 Why Connect to Our API?
Integrate Knowledge Base Optimizer directly into your applications and workflows. Automate content optimization, build custom dashboards, and create seamless integrations with your existing systems.
💼 Business Benefits
- • Automate content processing workflows
- • Integrate with your CMS or help desk
- • Scale content optimization across teams
- • Reduce manual content management tasks
🔧 Technical Benefits
- • RESTful API with JSON responses
- • Simple and intuitive endpoint structure
- • Secure API key authentication
- • Comprehensive error handling
🔑 Authentication
All API requests require a valid API key. Add your key to the subscription-key header for secure access.
📚 API Documentation
For the complete and up-to-date list of available API endpoints, please refer to our interactive Swagger documentation.
View Complete API Reference💡 Quick Start Examples
List all projects:
curl -X GET "https://kbo.visma.com/api/projects" \ -H "subscription-key: your-api-key-here"
Get project details:
curl -X GET "https://kbo.visma.com/api/projects/project-123" \ -H "subscription-key: your-api-key-here"
Retrieve optimized articles:
curl -X GET "https://kbo.visma.com/api/projects/project-123/articles" \ -H "subscription-key: your-api-key-here"
🧪 Testing Tutorial
Option 1: Test in Swagger (Recommended for Beginners)
- 1. Go to our Swagger documentation
- 2. Click the "Authorize" button at the top
- 3. Enter your API key in the
subscription-keyfield - 4. Click "Authorize" to save your key
- 5. Try any endpoint by clicking "Try it out" and then "Execute"
Option 2: Test with External Tools (Postman, cURL, etc.)
Use your preferred API testing tool. Here's how to set up the request:
Required Headers:
- •
subscription-key=your-api-key-here
Example URL:
https://kbo.visma.com/api/projects
💡 Remember to replace your-api-key-here with your real API key.
Frequently Asked Questions
❓ What if my processing fails or gets stuck?
If processing fails, you'll see an error status in your project dashboard. You can reset and retry processing by clicking the "Reset Project" button, which clears the status and allows you to process again.
❓ What file formats are supported?
For file uploads, we support PDF and Markdown files. You can also import content from websites and integrate with external knowledge base systems.
❓ How long does AI processing take?
Processing time depends on content volume and complexity. Most documents are processed within 5-10 minutes. You'll see real-time progress updates throughout the process.
❓ Can I customize the AI processing instructions?
Yes! You can provide specific instructions to tailor the AI optimization for your use case, such as "enhance for customer support" or "optimize for technical documentation."
❓ How many external integrations can I connect?
You can connect one account per integration type. This means you can have one Salesforce connection and one Zendesk connection active at the same time, but you cannot connect multiple accounts from the same service (e.g., two different Salesforce organizations).
❓ Can I edit the AI-optimized content?
Yes! You can review and edit all optimized content using our built-in editor before exporting. Both original and optimized versions are preserved.
❓ Can I delete or archive projects?
Yes, you can delete projects from your project dashboard. Deleted projects are archived and their associated files are removed from storage.
Ready to Optimize Your Knowledge Base?
Start your first project and see how AI can transform your documentation.