Skip to main content
The Knowledge Base API lets you programmatically create and manage knowledge bases that power AI features across the HoopAI platform. Train your knowledge bases with website content via URL crawling, add FAQ entries, and manage all trained data — giving your AI agents and conversation bots the context they need to deliver accurate responses.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

All endpoints require a Bearer token and an API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 to obtain an access token.

​
OAuth scopes

ScopeAccess
knowledge-base.readonlyRead knowledge bases, URLs, and FAQs
knowledge-base.writeCreate, update, delete knowledge bases and train content

​
Quick start

Create a knowledge base and train it with a website: 
# 1. Create a knowledge base
curl -X POST https://services.leadconnectorhq.com/knowledge-base/ \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Documentation",
    "locationId": "ve9EPM428h8vShlRW1KT"
  }'

# 2. Discover URLs from a website
curl -X POST https://services.leadconnectorhq.com/knowledge-base/kb_abc123/discover-website \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.example.com"
  }'

# 3. Train the discovered URLs
curl -X POST https://services.leadconnectorhq.com/knowledge-base/kb_abc123/train-urls \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://www.example.com/about",
      "https://www.example.com/faq"
    ]
  }'

​
Endpoints

​
Knowledge bases

MethodPathDescription
POST/knowledge-base/Create a knowledge base
GET/knowledge-base/List all knowledge bases for a location
GET/knowledge-base/{knowledgeBaseId}Get a knowledge base by ID
PUT/knowledge-base/{knowledgeBaseId}Update a knowledge base
DELETE/knowledge-base/{knowledgeBaseId}Delete a knowledge base

​
Web crawler

MethodPathDescription
POST/knowledge-base/{knowledgeBaseId}/discover-websiteDiscover URLs from a website
POST/knowledge-base/{knowledgeBaseId}/train-urlsTrain discovered URLs
GET/knowledge-base/{knowledgeBaseId}/crawling-statusGet crawling and training status
GET/knowledge-base/{knowledgeBaseId}/urlsGet all website URL data
DELETE/knowledge-base/{knowledgeBaseId}/urlsDelete trained URLs

​
FAQs

MethodPathDescription
POST/knowledge-base/{knowledgeBaseId}/faqsCreate a FAQ entry
GET/knowledge-base/{knowledgeBaseId}/faqsList all FAQ entries
PUT/knowledge-base/{knowledgeBaseId}/faqs/{faqId}Update a FAQ entry
DELETE/knowledge-base/{knowledgeBaseId}/faqs/{faqId}Delete a FAQ entry
Last modified on March 7, 2026