Skip to main content
GET
Semantic search contexts

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Query Parameters

q
string
required

Search query

Minimum string length: 1
limit
integer
default:20

Number of contexts to return

Required range: 1 <= x <= 100
include_highlights
boolean
default:true

Include match highlights

workspace_filter
string | null

Filter by specific workspace name

Response

Successful Response

Response for semantic search in contexts.

search_query
string
required

The search query used

search_metadata
ContextSemanticSearchMetadata · object
required

Search metadata

suggestions
ContextSemanticSearchSuggestions · object
required

Search suggestions

results
Results · object[]

Search results with scores