Skip to main content
POST
/
api
/
v1
/
collections
/
search
{
  "results": [
    {
      "content": "<string>",
      "score": 123,
      "metadata": {},
      "content_id": "<string>",
      "source": "<string>"
    }
  ],
  "total_results": 123,
  "query": "<string>",
  "search_type": "vector",
  "collection_id": "<string>",
  "execution_time_ms": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Workspace-Id
string | null

The workspace ID

Body

application/json

Request schema for knowledge search.

​
query
string
required

Search query string

​
collection_id
string
required

ID of the collection to search in

​
search_type
enum<string>

Type of search to perform

Available options:
vector,
keyword,
hybrid
​
filters
object

Additional filters to apply

​
max_results
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 100

Response

Successful Response

Response schema for knowledge search.

​
results
SearchResult · object[]
required

List of search results

​
total_results
integer
required

Total number of results found

​
query
string
required

Original search query

​
search_type
enum<string>
required

Type of search performed

Available options:
vector,
keyword,
hybrid
​
collection_id
string
required

Collection that was searched

​
execution_time_ms
number | null

Search execution time in milliseconds