Search articles (public)
curl --request GET \
--url https://{domain}/api/public/modules/knowledgebase/searchimport requests
url = "https://{domain}/api/public/modules/knowledgebase/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{domain}/api/public/modules/knowledgebase/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/public/modules/knowledgebase/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/public/modules/knowledgebase/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/public/modules/knowledgebase/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/public/modules/knowledgebase/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 64,
"title": "The MCP server for AI assistants",
"slug": "mcp-server",
"url": "https://billing.example.com/knowledgebase/modules-integrations/mcp-server",
"description": "Let an AI assistant read and manage Spartan through scoped, logged tokens.",
"snippet": "...you choose. Go to Developers, then MCP server. Tokens here only work against the MCP endpoint, and every token starts with no tools at all. The top of the page Tool calls today...",
"category": {
"id": 13,
"name": "Modules and Integrations",
"slug": "modules-integrations"
}
},
{
"id": 57,
"title": "Proxmox, VirtFusion, cPanel, Plesk and HestiaCP modules",
"slug": "vps-web-hosting-modules",
"url": "https://billing.example.com/knowledgebase/modules-integrations/vps-web-hosting-modules",
"description": "What each virtual server and web hosting module creates and what you set up before selling with it.",
"snippet": "...modules turn a paid order into a virtual server or a hosting account. Turn the one you need on under Integrations, Modules, Services, then open its Settings. Each one connects...",
"category": {
"id": 13,
"name": "Modules and Integrations",
"slug": "modules-integrations"
}
}
],
"meta": {
"request_id": "8d59600d-14a1-4051-8212-f3abb2a2ffbb"
}
}{
"error": {
"code": "validation_failed",
"message": "The request data is invalid.",
"details": {
"q": [
"The q field must be at least 2 characters."
]
}
},
"request_id": "74444d94-3e07-4898-9cfa-25acac898b61"
}{
"error": {
"code": "too_many_requests",
"message": "Too many requests. Retry after the number of seconds in the Retry-After header.",
"details": {}
},
"request_id": "db4f5a74-f1c8-4554-a36b-7dced81670a8"
}Knowledge Base (public)
Search articles (public)
Ranked search over active articles, the same ranking the site search uses. Returns up to the best matches with a text snippet. Not paginated.
This is the public, keyless version. It only returns what an anonymous visitor can see on your site, is cached for 60 seconds (edits in the admin area show up at once) and allows 60 requests per minute per IP.
Authentication: none, no API key needed.
Rate limit: 60 requests per minute per IP.
GET
/
public
/
modules
/
knowledgebase
/
search
Search articles (public)
curl --request GET \
--url https://{domain}/api/public/modules/knowledgebase/searchimport requests
url = "https://{domain}/api/public/modules/knowledgebase/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{domain}/api/public/modules/knowledgebase/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/public/modules/knowledgebase/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/public/modules/knowledgebase/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/public/modules/knowledgebase/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/public/modules/knowledgebase/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 64,
"title": "The MCP server for AI assistants",
"slug": "mcp-server",
"url": "https://billing.example.com/knowledgebase/modules-integrations/mcp-server",
"description": "Let an AI assistant read and manage Spartan through scoped, logged tokens.",
"snippet": "...you choose. Go to Developers, then MCP server. Tokens here only work against the MCP endpoint, and every token starts with no tools at all. The top of the page Tool calls today...",
"category": {
"id": 13,
"name": "Modules and Integrations",
"slug": "modules-integrations"
}
},
{
"id": 57,
"title": "Proxmox, VirtFusion, cPanel, Plesk and HestiaCP modules",
"slug": "vps-web-hosting-modules",
"url": "https://billing.example.com/knowledgebase/modules-integrations/vps-web-hosting-modules",
"description": "What each virtual server and web hosting module creates and what you set up before selling with it.",
"snippet": "...modules turn a paid order into a virtual server or a hosting account. Turn the one you need on under Integrations, Modules, Services, then open its Settings. Each one connects...",
"category": {
"id": 13,
"name": "Modules and Integrations",
"slug": "modules-integrations"
}
}
],
"meta": {
"request_id": "8d59600d-14a1-4051-8212-f3abb2a2ffbb"
}
}{
"error": {
"code": "validation_failed",
"message": "The request data is invalid.",
"details": {
"q": [
"The q field must be at least 2 characters."
]
}
},
"request_id": "74444d94-3e07-4898-9cfa-25acac898b61"
}{
"error": {
"code": "too_many_requests",
"message": "Too many requests. Retry after the number of seconds in the Retry-After header.",
"details": {}
},
"request_id": "db4f5a74-f1c8-4554-a36b-7dced81670a8"
}Was this page helpful?

