Skip to main content
POST
Search Document Pages

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string | null

Body

application/json
query
string
required

The search query

metadata_filter
Metadata Filter · object | null

Optional metadata filters using MongoDB-like query syntax

created_at_filter
Created At Filter · object | null

Filter by created_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')

updated_at_filter
Updated At Filter · object | null

Filter by updated_at database field. Supports operators: $eq, $ne, $gt, $lt, $gte, $lte, $in, $nin. Use ISO date format (e.g., '2024-01-01T00:00:00')

top_k
integer
default:5

Number of results to return

Required range: 1 <= x <= 1000
optimize_metadata
boolean
default:false

If True, optimize the metadata filter based on the query

optimize_query
boolean
default:false

If True, optimize the query by removing parts covered by metadata filter

Response

Successful Response

data
RelevantPagesResponseData · object
required

Response data

success
boolean
default:true
error
ErrorDetail · object | null

Schema for API error responses.

Example:
meta
MetaData · object

Metadata for API responses