Skip to main content
POST
Search knowledge-base chunks
Supply a text query, optional document UUIDs, and a result limit (default 5, maximum 50). min_similarity ranges from 0 to 1. Search requires a configured embedding provider and documents processed for chunked retrieval. The response contains chunks, the query, and total_results. No matches is a valid result. Full-document attachments do not imply searchable chunks exist.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Body

application/json
query
string
required
document_uuids
string[] | null
limit
integer
default:5
Required range: 1 <= x <= 50
min_similarity
number | null
Required range: 0 <= x <= 1

Response

Successful Response

chunks
ChunkResponseSchema · object[]
required
query
string
required
total_results
integer
required