Publish or unpublish a document
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_public": true,
"slug": "refund-policy",
"summary": "How and when customers can request a refund."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication"
payload = {
"is_public": True,
"slug": "refund-policy",
"summary": "How and when customers can request a refund."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_public: true,
slug: 'refund-policy',
summary: 'How and when customers can request a refund.'
})
};
fetch('https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication', 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.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_public' => true,
'slug' => 'refund-policy',
'summary' => 'How and when customers can request a refund.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication"
payload := strings.NewReader("{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"knowledge_base_id": "<string>",
"name": "<string>",
"type": "<string>",
"source_url": "<string>",
"status": "<string>",
"chunk_count": 123,
"size_bytes": 123,
"is_public": true,
"slug": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Knowledge Bases
Publish or unpublish a document
Toggle a document’s public help-center publication. Set is_public to true (with a URL slug) to expose the article at the public help-center path, or false to take it down. An optional summary overrides the article’s public excerpt. A slug is required whenever is_public is true. Requires the knowledge:write scope (admin / owner / developer).
PATCH
/
api
/
v1
/
knowledge-bases
/
{id}
/
documents
/
{docId}
/
publication
Publish or unpublish a document
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_public": true,
"slug": "refund-policy",
"summary": "How and when customers can request a refund."
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication"
payload = {
"is_public": True,
"slug": "refund-policy",
"summary": "How and when customers can request a refund."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_public: true,
slug: 'refund-policy',
summary: 'How and when customers can request a refund.'
})
};
fetch('https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication', 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.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'is_public' => true,
'slug' => 'refund-policy',
'summary' => 'How and when customers can request a refund.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication"
payload := strings.NewReader("{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/knowledge-bases/{id}/documents/{docId}/publication")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_public\": true,\n \"slug\": \"refund-policy\",\n \"summary\": \"How and when customers can request a refund.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"knowledge_base_id": "<string>",
"name": "<string>",
"type": "<string>",
"source_url": "<string>",
"status": "<string>",
"chunk_count": 123,
"size_bytes": 123,
"is_public": true,
"slug": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Whether the document should be publicly visible in the help center.
Public URL slug (lowercase letters, digits, hyphens). Required when is_public is true.
Maximum string length:
200Pattern:
^[a-z0-9-]+$Optional public excerpt shown for the article.
Maximum string length:
2000⌘I