Skip to main content
POST
Search a knowledge base

Authorizations

Authorization
string
header
required

User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.

X-Organization-ID
string
header
required

Required organization context for org-scoped endpoints.

Path Parameters

knowledge_id
string<uuid>
required

Knowledge base UUID.

Body

application/json
query
string
required

Search query.

Minimum string length: 1
top_k
integer
default:5

Number of results.

Required range: 1 <= x <= 50
min_score
number<float>
default:0

Minimum similarity score.

Required range: 0 <= x <= 1
filters
object | null

Optional metadata filters.

include_content
boolean
default:true

Include chunk content.

include_metadata
boolean
default:true

Include chunk metadata.

Response

Search results.

query
string
knowledge_base_id
string<uuid>
top_k
integer
total_matches
integer
matches
object[]