Search knowledge documents
curl --request POST \
--url https://api.gleap.io/v3/knowledge/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"query": "<string>",
"documentTypeFilter": "<string>",
"internally": true,
"lang": "<string>",
"limit": 123
}
'import requests
url = "https://api.gleap.io/v3/knowledge/search"
payload = {
"query": "<string>",
"documentTypeFilter": "<string>",
"internally": True,
"lang": "<string>",
"limit": 123
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: '<string>',
documentTypeFilter: '<string>',
internally: true,
lang: '<string>',
limit: 123
})
};
fetch('https://api.gleap.io/v3/knowledge/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://api.gleap.io/v3/knowledge/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'documentTypeFilter' => '<string>',
'internally' => true,
'lang' => '<string>',
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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.gleap.io/v3/knowledge/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.post("https://api.gleap.io/v3/knowledge/search")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/knowledge/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"sourceId": "<string>",
"sourceType": "<string>",
"content": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"count": 123
}Knowledge
Search knowledge documents
Search through knowledge base documents using vector search and reranking.
Returns matching documents from help-center articles, FAQs/snippets, websites, news, YouTube videos,
and code knowledge. limit caps the number of returned documents; retrieval returns at most 10
documents regardless of a higher limit.
POST
/
knowledge
/
search
Search knowledge documents
curl --request POST \
--url https://api.gleap.io/v3/knowledge/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"query": "<string>",
"documentTypeFilter": "<string>",
"internally": true,
"lang": "<string>",
"limit": 123
}
'import requests
url = "https://api.gleap.io/v3/knowledge/search"
payload = {
"query": "<string>",
"documentTypeFilter": "<string>",
"internally": True,
"lang": "<string>",
"limit": 123
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: '<string>',
documentTypeFilter: '<string>',
internally: true,
lang: '<string>',
limit: 123
})
};
fetch('https://api.gleap.io/v3/knowledge/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://api.gleap.io/v3/knowledge/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'documentTypeFilter' => '<string>',
'internally' => true,
'lang' => '<string>',
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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.gleap.io/v3/knowledge/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.post("https://api.gleap.io/v3/knowledge/search")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/knowledge/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"documentTypeFilter\": \"<string>\",\n \"internally\": true,\n \"lang\": \"<string>\",\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"sourceId": "<string>",
"sourceType": "<string>",
"content": "<string>",
"title": "<string>",
"url": "<string>"
}
],
"count": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
⌘I