Semantic Search
curl --request POST \
--url https://api.gurubase.io/api/v1/{guru_slug}/semantic-search/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"question": "<string>",
"labels": [
{}
],
"external_user_id": "<string>"
}
'import requests
url = "https://api.gurubase.io/api/v1/{guru_slug}/semantic-search/"
payload = {
"question": "<string>",
"labels": [{}],
"external_user_id": "<string>"
}
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({question: '<string>', labels: [{}], external_user_id: '<string>'})
};
fetch('https://api.gurubase.io/api/v1/{guru_slug}/semantic-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.gurubase.io/api/v1/{guru_slug}/semantic-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([
'question' => '<string>',
'labels' => [
[
]
],
'external_user_id' => '<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://api.gurubase.io/api/v1/{guru_slug}/semantic-search/"
payload := strings.NewReader("{\n \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<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://api.gurubase.io/api/v1/{guru_slug}/semantic-search/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gurubase.io/api/v1/{guru_slug}/semantic-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 \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sources": [
{
"title": "Slack Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/slack-bot",
"display_link": true,
"labels": [
"integrations",
"slack",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "GitHub Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/github-bot",
"display_link": true,
"labels": [
"integrations",
"github",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Welcome to Gurubase - Gurubase",
"link": "https://docs.gurubase.ai/introduction",
"display_link": true,
"labels": [
"documentation",
"getting-started"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Quickstart - Gurubase",
"link": "https://docs.gurubase.ai/quickstart",
"display_link": true,
"labels": [
"documentation",
"getting-started",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Create Your First Guru - Gurubase",
"link": "https://docs.gurubase.ai/guides/create-guru",
"display_link": true,
"labels": [
"documentation",
"guides",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "head.html",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/examples/retype/_includes/head.html",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"examples"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "widget.js",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/src/widget.js",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"javascript"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "Website Widget Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/website-widget",
"display_link": true,
"labels": [
"integrations",
"widget",
"website"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Jira Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/jira-bot",
"display_link": true,
"labels": [
"integrations",
"jira",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "API Reference - Gurubase",
"link": "https://docs.gurubase.ai/api-reference/introduction",
"display_link": true,
"labels": [
"documentation",
"api",
"reference"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
}
],
"total_sources": 10
}
{
"error": "Question is required"
}
{
"error": "Invalid API key"
}
{
"error": "Guru not found"
}
{
"error": "Rate limit exceeded"
}
{
"error": "Error fetching sources: [error details]"
}
Endpoints
Semantic Search
Fetch related sources for a question
POST
/
{guru_slug}
/
semantic-search
/
Semantic Search
curl --request POST \
--url https://api.gurubase.io/api/v1/{guru_slug}/semantic-search/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"question": "<string>",
"labels": [
{}
],
"external_user_id": "<string>"
}
'import requests
url = "https://api.gurubase.io/api/v1/{guru_slug}/semantic-search/"
payload = {
"question": "<string>",
"labels": [{}],
"external_user_id": "<string>"
}
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({question: '<string>', labels: [{}], external_user_id: '<string>'})
};
fetch('https://api.gurubase.io/api/v1/{guru_slug}/semantic-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.gurubase.io/api/v1/{guru_slug}/semantic-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([
'question' => '<string>',
'labels' => [
[
]
],
'external_user_id' => '<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://api.gurubase.io/api/v1/{guru_slug}/semantic-search/"
payload := strings.NewReader("{\n \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<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://api.gurubase.io/api/v1/{guru_slug}/semantic-search/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gurubase.io/api/v1/{guru_slug}/semantic-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 \"question\": \"<string>\",\n \"labels\": [\n {}\n ],\n \"external_user_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sources": [
{
"title": "Slack Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/slack-bot",
"display_link": true,
"labels": [
"integrations",
"slack",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "GitHub Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/github-bot",
"display_link": true,
"labels": [
"integrations",
"github",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Welcome to Gurubase - Gurubase",
"link": "https://docs.gurubase.ai/introduction",
"display_link": true,
"labels": [
"documentation",
"getting-started"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Quickstart - Gurubase",
"link": "https://docs.gurubase.ai/quickstart",
"display_link": true,
"labels": [
"documentation",
"getting-started",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Create Your First Guru - Gurubase",
"link": "https://docs.gurubase.ai/guides/create-guru",
"display_link": true,
"labels": [
"documentation",
"guides",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "head.html",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/examples/retype/_includes/head.html",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"examples"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "widget.js",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/src/widget.js",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"javascript"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "Website Widget Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/website-widget",
"display_link": true,
"labels": [
"integrations",
"widget",
"website"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Jira Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/jira-bot",
"display_link": true,
"labels": [
"integrations",
"jira",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "API Reference - Gurubase",
"link": "https://docs.gurubase.ai/api-reference/introduction",
"display_link": true,
"labels": [
"documentation",
"api",
"reference"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
}
],
"total_sources": 10
}
{
"error": "Question is required"
}
{
"error": "Invalid API key"
}
{
"error": "Guru not found"
}
{
"error": "Rate limit exceeded"
}
{
"error": "Error fetching sources: [error details]"
}
Retrieve sources that are most relevant to a given question. This endpoint fetches from all data source types.
Path Parameters
string
required
The slug of the Guru to query sources from
Headers
string
required
Your API key for authentication. You can obtain your API key from the Gurubase dashboard.
Body Parameters
string
required
The question to find related sources for
array
Array of labels to filter sources by. If provided, only sources with matching labels will be returned. If multiple labels are provided, they are OR’ed. Meaning data sources belonging to any of those labels are returned.
string
External user identifier. This allows you to track search queries per user in your analytics. It should be UUID.
Response
The response contains an array of source objects and total count.object[]
Array of source objects relevant to the question (maximum 10)Each source object contains:
title(string): The title of the source document or pagelink(string): The URL link to the source (can be null for internal sources)display_link(boolean): Whether to display the link in the UIicon_url(string): URL of the icon representing the sourcelabels(array): Array of labels associated with this source
number
Total number of sources returned
{
"sources": [
{
"title": "Slack Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/slack-bot",
"display_link": true,
"labels": [
"integrations",
"slack",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "GitHub Bot Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/github-bot",
"display_link": true,
"labels": [
"integrations",
"github",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Welcome to Gurubase - Gurubase",
"link": "https://docs.gurubase.ai/introduction",
"display_link": true,
"labels": [
"documentation",
"getting-started"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Quickstart - Gurubase",
"link": "https://docs.gurubase.ai/quickstart",
"display_link": true,
"labels": [
"documentation",
"getting-started",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Create Your First Guru - Gurubase",
"link": "https://docs.gurubase.ai/guides/create-guru",
"display_link": true,
"labels": [
"documentation",
"guides",
"tutorial"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "head.html",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/examples/retype/_includes/head.html",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"examples"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "widget.js",
"link": "https://github.com/gurubase/gurubase-widget/tree/master/src/widget.js",
"display_link": true,
"labels": [
"code",
"github",
"widget",
"javascript"
],
"icon_url": "https://github.com/favicon.ico"
},
{
"title": "Website Widget Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/website-widget",
"display_link": true,
"labels": [
"integrations",
"widget",
"website"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "Jira Integration - Gurubase",
"link": "https://docs.gurubase.ai/integrations/jira-bot",
"display_link": true,
"labels": [
"integrations",
"jira",
"bots"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
},
{
"title": "API Reference - Gurubase",
"link": "https://docs.gurubase.ai/api-reference/introduction",
"display_link": true,
"labels": [
"documentation",
"api",
"reference"
],
"icon_url": "https://mintlify.s3-us-west-1.amazonaws.com/gurubase/_generated/favicon/favicon-32x32.png?v=3"
}
],
"total_sources": 10
}
{
"error": "Question is required"
}
{
"error": "Invalid API key"
}
{
"error": "Guru not found"
}
{
"error": "Rate limit exceeded"
}
{
"error": "Error fetching sources: [error details]"
}
Was this page helpful?
⌘I