JavaScript
import BrainbaseLabs from 'brainbase-labs';
const client = new BrainbaseLabs({
apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});
const response = await client.workers.resources.query('workerId', { query: 'query' });
console.log(response.data);import os
from brainbase_labs import BrainbaseLabs
client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
response = client.workers.resources.query(
worker_id="workerId",
query="query",
)
print(response.data)curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"queryParams": {
"mode": "<string>",
"onlyNeedContext": true,
"onlyNeedPrompt": true,
"responseType": "<string>",
"stream": true,
"topK": 123,
"maxTokenForTextUnit": 123,
"maxTokenForGlobalContext": 123,
"maxTokenForLocalContext": 123
},
"resources": [
"<string>"
],
"folderId": "<string>",
"folderName": "<string>"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query",
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>',
'queryParams' => [
'mode' => '<string>',
'onlyNeedContext' => true,
'onlyNeedPrompt' => true,
'responseType' => '<string>',
'stream' => true,
'topK' => 123,
'maxTokenForTextUnit' => 123,
'maxTokenForGlobalContext' => 123,
'maxTokenForLocalContext' => 123
],
'resources' => [
'<string>'
],
'folderId' => '<string>',
'folderName' => '<string>'
]),
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://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\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://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query")
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 \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"invalidResourceIds": [
"<string>"
]
}Resources
Query RAG resources using vector search
POST
/
api
/
workers
/
{workerId}
/
resources
/
query
JavaScript
import BrainbaseLabs from 'brainbase-labs';
const client = new BrainbaseLabs({
apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});
const response = await client.workers.resources.query('workerId', { query: 'query' });
console.log(response.data);import os
from brainbase_labs import BrainbaseLabs
client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
response = client.workers.resources.query(
worker_id="workerId",
query="query",
)
print(response.data)curl --request POST \
--url https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "<string>",
"queryParams": {
"mode": "<string>",
"onlyNeedContext": true,
"onlyNeedPrompt": true,
"responseType": "<string>",
"stream": true,
"topK": 123,
"maxTokenForTextUnit": 123,
"maxTokenForGlobalContext": 123,
"maxTokenForLocalContext": 123
},
"resources": [
"<string>"
],
"folderId": "<string>",
"folderName": "<string>"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query",
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>',
'queryParams' => [
'mode' => '<string>',
'onlyNeedContext' => true,
'onlyNeedPrompt' => true,
'responseType' => '<string>',
'stream' => true,
'topK' => 123,
'maxTokenForTextUnit' => 123,
'maxTokenForGlobalContext' => 123,
'maxTokenForLocalContext' => 123
],
'resources' => [
'<string>'
],
'folderId' => '<string>',
'folderName' => '<string>'
]),
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://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\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://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brainbase-monorepo-api.onrender.com/api/workers/{workerId}/resources/query")
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 \"queryParams\": {\n \"mode\": \"<string>\",\n \"onlyNeedContext\": true,\n \"onlyNeedPrompt\": true,\n \"responseType\": \"<string>\",\n \"stream\": true,\n \"topK\": 123,\n \"maxTokenForTextUnit\": 123,\n \"maxTokenForGlobalContext\": 123,\n \"maxTokenForLocalContext\": 123\n },\n \"resources\": [\n \"<string>\"\n ],\n \"folderId\": \"<string>\",\n \"folderName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"error": "<string>",
"invalidResourceIds": [
"<string>"
]
}Authorizations
API key authentication
Path Parameters
Body
application/json
Response
Query results
Query result data from the RAG service
⌘I
