Search indexed content
curl --request POST \
--url https://bulkgrid.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"queries": [
"<string>"
],
"queryMode": "auto",
"limit": 10,
"collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fullTextWeight": 0.3,
"semanticWeight": 0.7,
"rrfK": 60
}
'import requests
url = "https://bulkgrid.com/api/v1/search"
payload = {
"query": "<string>",
"queries": ["<string>"],
"queryMode": "auto",
"limit": 10,
"collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fullTextWeight": 0.3,
"semanticWeight": 0.7,
"rrfK": 60
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
queries: ['<string>'],
queryMode: 'auto',
limit: 10,
collectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fullTextWeight: 0.3,
semanticWeight: 0.7,
rrfK: 60
})
};
fetch('https://bulkgrid.com/api/v1/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://bulkgrid.com/api/v1/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>',
'queries' => [
'<string>'
],
'queryMode' => 'auto',
'limit' => 10,
'collectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fullTextWeight' => 0.3,
'semanticWeight' => 0.7,
'rrfK' => 60
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://bulkgrid.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://bulkgrid.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"queryMode": "none",
"executedQueries": [
"<string>"
],
"scoring": {
"fullTextWeight": 123,
"semanticWeight": 123,
"rrfK": 0
},
"results": [
{
"chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"chunk_index": 0,
"text_content": "<string>",
"metadata": "<unknown>",
"fts_rank": 123,
"semantic_rank": 123,
"score": 123
}
],
"count": 4503599627370495
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Search
Search indexed content
Required permission: search:query.
POST
/
api
/
v1
/
search
Search indexed content
curl --request POST \
--url https://bulkgrid.com/api/v1/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"queries": [
"<string>"
],
"queryMode": "auto",
"limit": 10,
"collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fullTextWeight": 0.3,
"semanticWeight": 0.7,
"rrfK": 60
}
'import requests
url = "https://bulkgrid.com/api/v1/search"
payload = {
"query": "<string>",
"queries": ["<string>"],
"queryMode": "auto",
"limit": 10,
"collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fullTextWeight": 0.3,
"semanticWeight": 0.7,
"rrfK": 60
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
queries: ['<string>'],
queryMode: 'auto',
limit: 10,
collectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fullTextWeight: 0.3,
semanticWeight: 0.7,
rrfK: 60
})
};
fetch('https://bulkgrid.com/api/v1/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://bulkgrid.com/api/v1/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>',
'queries' => [
'<string>'
],
'queryMode' => 'auto',
'limit' => 10,
'collectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fullTextWeight' => 0.3,
'semanticWeight' => 0.7,
'rrfK' => 60
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://bulkgrid.com/api/v1/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://bulkgrid.com/api/v1/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"queries\": [\n \"<string>\"\n ],\n \"queryMode\": \"auto\",\n \"limit\": 10,\n \"collectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fullTextWeight\": 0.3,\n \"semanticWeight\": 0.7,\n \"rrfK\": 60\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"queryMode": "none",
"executedQueries": [
"<string>"
],
"scoring": {
"fullTextWeight": 123,
"semanticWeight": 123,
"rrfK": 0
},
"results": [
{
"chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"chunk_index": 0,
"text_content": "<string>",
"metadata": "<unknown>",
"fts_rank": 123,
"semantic_rank": 123,
"score": 123
}
],
"count": 4503599627370495
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Authorizations
apiKeyAuthbearerAuth
Bulkgrid API key
Body
application/json
Minimum string length:
1Maximum array length:
3Minimum string length:
1Available options:
none, auto Required range:
1 <= x <= 50Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
0 <= x <= 1Required range:
0 <= x <= 1Required range:
1 <= x <= 1000