Introduction to HelpSpace AI

Welcome to HelpSpace AI! This documentation will help you get started with setting up and using our AI-powered knowledge base and support platform.

HelpSpace AI transforms your FAQs, product documentation, and support tickets into an intelligent, conversational knowledge hub. Your customers and team members can find answers instantly through natural language queries.

Quick Start Guide

Get up and running with HelpSpace AI in just a few minutes:

Step 1: Create Your Account

Step 2: Create Your First Knowledge Base

Once logged in, click "Create Knowledge Base" and give it a name. You can create separate knowledge bases for different products or teams.

Step 3: Add Content

You have several options to add content:

Manual Entry: Create articles directly in the editor
Import: Upload markdown files, CSV, or connect to existing tools
Sync: Connect to Notion, Confluence, or Google Docs for automatic sync

Step 4: Deploy Your AI Assistant

Once your content is ready, deploy your AI assistant by copying the embed code to your website or enabling the Slack integration.

<script src="https://cdn.helpspace.tech/widget.js"></script>
<script>
  HelpSpace.init({
    projectId: 'your-project-id',
    theme: 'auto'
  });
</script>

Core Concepts

Knowledge Bases

A knowledge base is a collection of articles, FAQs, and documentation organized around a specific topic or product. You can create multiple knowledge bases and control access to each.

Articles

Articles are the building blocks of your knowledge base. Each article has a title, content, and metadata like categories and tags. The AI uses these to understand and retrieve information.

AI Training

When you add or update content, our AI automatically processes it to understand the context, relationships, and key concepts. This enables natural language querying and conversational responses.

Creating Articles

Articles support rich formatting including:

Markdown syntax for easy writing
Code blocks with syntax highlighting
Images and embedded videos
Tables and lists
Internal links to other articles

Importing Content

HelpSpace AI supports importing from various sources:

Markdown Files: Upload .md files directly
CSV: Bulk import with title, content, and category columns
Notion: One-click sync with your Notion workspace
Confluence: Connect your Atlassian account
Zendesk: Import existing help center articles
Intercom: Sync your Intercom articles

API Reference

Our REST API allows you to programmatically manage your knowledge base and query the AI assistant.

Authentication

All API requests require an API key passed in the header:

Authorization: Bearer your-api-key

Query the AI

POST /api/v1/query
Content-Type: application/json

{
  "question": "How do I reset my password?",
  "project_id": "your-project-id"
}

Response

{
  "answer": "To reset your password, click on 'Forgot Password'...",
  "sources": [
    {
      "title": "Password Reset Guide",
      "url": "/articles/password-reset"
    }
  ],
  "confidence": 0.95
}

Documentation