Skip to main content
POST
/
api
/
datasets
/
{id}
/
search-documents
Search Documents
curl --request POST \
  --url https://app.baseplate.ai/api/datasets/{id}/search-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "top_k": 123
}
'
import requests

url = "https://app.baseplate.ai/api/datasets/{id}/search-documents"

payload = {
"query": "<string>",
"top_k": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', top_k: 123})
};

fetch('https://app.baseplate.ai/api/datasets/{id}/search-documents', 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://app.baseplate.ai/api/datasets/{id}/search-documents",
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>',
'top_k' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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://app.baseplate.ai/api/datasets/{id}/search-documents"

payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"top_k\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

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://app.baseplate.ai/api/datasets/{id}/search-documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"top_k\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.baseplate.ai/api/datasets/{id}/search-documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"top_k\": 123\n}"

response = http.request(request)
puts response.read_body

Path Parameters

id
string
required
Dataset ID
Authorization
string
Baseplate API key. Must be in the format β€œBearer $BASEPLATE_API_KEY”

Body Parameters

query
string
required
Query string
top_k
number
default:"3"
Number of closest matches

Responses

🟒 200: OK
{
    "results": [
        {
            "document_id": "fc74e81e-05ac-4df6-936f-ce51cc69a868",
            "dataset_id": "e2fa7f7b-d580-4ecf-8232-a1131938a3fc",
            "content": "",
            "filename": "example.pdf",
            "url": "/928f94ee-4c7c-451a-bf3c-f1baa08c67b0/example.pdf",
            "similarity": 0.0919062
        }
    ]
}