Semantic + Keyword Search
curl --request POST \
--url https://api.shieldbase.ai/external/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Secret: <api-key>' \
--data '
{
"keyword": "<string>",
"limit": 20,
"group_by_file": false
}
'import requests
url = "https://api.shieldbase.ai/external/search"
payload = {
"keyword": "<string>",
"limit": 20,
"group_by_file": False
}
headers = {
"X-Client-ID": "<api-key>",
"X-API-Key": "<api-key>",
"X-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-ID': '<api-key>',
'X-API-Key': '<api-key>',
'X-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({keyword: '<string>', limit: 20, group_by_file: false})
};
fetch('https://api.shieldbase.ai/external/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.shieldbase.ai/external/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([
'keyword' => '<string>',
'limit' => 20,
'group_by_file' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Client-ID: <api-key>",
"X-Secret: <api-key>"
],
]);
$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.shieldbase.ai/external/search"
payload := strings.NewReader("{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Client-ID", "<api-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-Secret", "<api-key>")
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.shieldbase.ai/external/search")
.header("X-Client-ID", "<api-key>")
.header("X-API-Key", "<api-key>")
.header("X-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shieldbase.ai/external/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
request["X-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}"
response = http.request(request)
puts response.read_bodyEndpoint Examples
Semantic + Keyword Search
Perform hybrid BM25 + semantic vector search across all indexed content
POST
/
external
/
search
Semantic + Keyword Search
curl --request POST \
--url https://api.shieldbase.ai/external/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Secret: <api-key>' \
--data '
{
"keyword": "<string>",
"limit": 20,
"group_by_file": false
}
'import requests
url = "https://api.shieldbase.ai/external/search"
payload = {
"keyword": "<string>",
"limit": 20,
"group_by_file": False
}
headers = {
"X-Client-ID": "<api-key>",
"X-API-Key": "<api-key>",
"X-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-ID': '<api-key>',
'X-API-Key': '<api-key>',
'X-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({keyword: '<string>', limit: 20, group_by_file: false})
};
fetch('https://api.shieldbase.ai/external/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.shieldbase.ai/external/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([
'keyword' => '<string>',
'limit' => 20,
'group_by_file' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Client-ID: <api-key>",
"X-Secret: <api-key>"
],
]);
$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.shieldbase.ai/external/search"
payload := strings.NewReader("{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Client-ID", "<api-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-Secret", "<api-key>")
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.shieldbase.ai/external/search")
.header("X-Client-ID", "<api-key>")
.header("X-API-Key", "<api-key>")
.header("X-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shieldbase.ai/external/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-API-Key"] = '<api-key>'
request["X-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keyword\": \"<string>\",\n \"limit\": 20,\n \"group_by_file\": false\n}"
response = http.request(request)
puts response.read_body⌘I