Skip to main content
POST
Search a knowledge base

Authorizations

Authorization
string
header
required

Workspace API key sent as Authorization: Bearer <api_key>.

Path Parameters

workspace_id
string<uuid>
required

Workspace UUID

knowledge_base_id
string<uuid>
required

Knowledge base UUID

Body

application/json
search_query
string
required
Example:

"How do I reset my password?"

search_type
enum<string>
required
Available options:
hybrid,
vector,
full_text
Example:

"hybrid"

search_chunk_limit
integer
required
Required range: 1 <= x <= 20
Example:

5

search_score_threshold
number
required
Required range: 0 <= x <= 1
Example:

0.5

Response

search results returned

message
string
required
Example:

"Successfully ran a search on a knowledge base."

response
object
required