Skip to main content
POST
Run a search

Authorizations

Authorization
string
header
required

API token issued from the Splendor console.

Headers

x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json
aggregations
AggregationRequest · object[]
collapse
enum<string> | null

Override how lexical hits map to results. 'document' returns the best-ranked record per document (use to force a document listing from a filter-only browse); 'record' returns every matching record (use with a document filter to enumerate each instance of a term within one document). Defaults to document collapse for ranked text and record semantics for filter-only browses. Not valid with semantic search, which always returns document-level results.

Available options:
document,
record
content_filter
enum<string>
default:text

For semantic search, which modalities to retrieve: 'text' (default) searches text/document embeddings; 'images' searches image embeddings via SigLIP; 'all' searches both and merges the results.

Available options:
all,
text,
images
cursor
string | null
Minimum string length: 1
dataset_scope
enum<string>
default:selected
Available options:
selected,
all
datasets
string[]
limit
integer
default:20
Required range: 0 <= x <= 1000
max_expansion_terms
integer
default:10
Required range: 1 <= x <= 50
q
string | null
semantic
boolean
default:false
semantic_min_score
number | null
text
string | null
time
TimeRange · object | null
where
StructuredFilter · object[]

Response

Successful Response

The response is of type object.