API
Search Documents
Full text search for documents in a dataset. Based on keywords in the query.
POST
/
api
/
datasets
/
{id}
/
search-documents
Authorization
Path
Body
curl --request POST \
--url https://app.baseplate.ai/api/datasets/{id}/search-documents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"query": "<string>",
"top_k": 123
}'
Path Parameters
id
string
requiredDataset ID
Header
Authorization
string
Baseplate API key. Must be in the format βBearer $BASEPLATE_API_KEYβ
Body Parameters
query
string
requiredQuery 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
}
]
}
curl --request POST \
--url https://app.baseplate.ai/api/datasets/{id}/search-documents \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"query": "<string>",
"top_k": 123
}'