Get Public KB Articles
curl --request GET \
--url https://api.example.com/kb/{public_slug}import requests
url = "https://api.example.com/kb/{public_slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/kb/{public_slug}', 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://api.example.com/kb/{public_slug}",
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://api.example.com/kb/{public_slug}"
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://api.example.com/kb/{public_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kb/{public_slug}")
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_bodyKnowledge Base
Get Public KB Articles
Get published knowledge base articles by public slug
GET
/
kb
/
{public_slug}
Get Public KB Articles
curl --request GET \
--url https://api.example.com/kb/{public_slug}import requests
url = "https://api.example.com/kb/{public_slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/kb/{public_slug}', 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://api.example.com/kb/{public_slug}",
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://api.example.com/kb/{public_slug}"
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://api.example.com/kb/{public_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kb/{public_slug}")
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_bodyRetrieves a set of published knowledge base articles by its public slug. Returns the articles array and metadata. This endpoint does not require authentication.
Path Parameters
string
required
The unique public slug of the KB article set.
Request
curl -X GET "https://app.shipstar.ai/api/v1/kb/shipstar-knowledge-base"
const slug = 'shipstar-knowledge-base';
const response = await fetch(`https://app.shipstar.ai/api/v1/kb/${slug}`);
const kb = await response.json();
import requests
slug = 'shipstar-knowledge-base'
response = requests.get(f'https://app.shipstar.ai/api/v1/kb/{slug}')
kb = response.json()
Response
Returns the KB article set with its full content, including categorized articles.Example Response
200
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"slug": "shipstar-knowledge-base",
"content": "{\"articles\": [{\"category\": \"Getting Started\", \"title\": \"How to connect your GitHub account\", \"body\": \"Navigate to Sources in your dashboard and click Connect GitHub...\"}, {\"category\": \"Content Generation\", \"title\": \"Generating your first changelog\", \"body\": \"Once your repositories are connected, go to the Content tab...\"}]}",
"published_at": "2025-03-31T12:00:00Z",
"created_at": "2025-03-31T10:00:00Z"
}
Errors
| Status | Description |
|---|---|
| 404 | KB articles not found or not published |
| 422 | Invalid slug format |
Was this page helpful?
⌘I