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

Documentation Index

Fetch the complete documentation index at: https://docs.baseplate.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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
​
filter
object
Metadata filter. Uses Pinecone filter syntax: https://docs.pinecone.io/docs/metadata-filtering
​
alpha
number
Alpha value for hybrid search.

​
Responses

🟢 200: OK
{
  "results": [
    {
      "embedding": "a search warrant at Defendant Pebbles Jean- Paul’s",
      "data": {
        "text": "a search warrant at Defendant Pebbles Jean- Paul’s",
        "author": "Andrew Luo"
      },
      "confidence": 0.76768893,
      "query": "hello",
      "metadata": {
        "rowId": 208422,
        "state": "ark",
        "url": "/973179d1-2edd-49f9-aa3e-32785bb3fa01/data.txt"
      }
    }
  ]
}